Commit Graph
45 Commits
Author SHA1 Message Date
Richard Levitte b151768bbd fixup! doc(doc/userguide.md): document configuration file fields
Signed-off-by: Richard Levitte <richard@levitte.org>
2025-07-15 12:55:13 +02:00
Lars Wirzenius 9d218bd92f doc(doc/userguide.md): document configuration file fields
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-07-15 12:37:41 +03:00
Tshepang Mbambo 97a904c6cb use a consistent config name 2025-06-14 16:11:20 +02:00
Tshepang Mbambo 0261d2523d remove debatable statement
Installing a Rust toolchain installed is not obviously more easy than
adding a distro package repo.
2025-06-14 16:08:30 +02:00
Tshepang Mbambo 3c0e165763 some text fixes 2025-06-14 16:08:10 +02:00
Lars Wirzenius a90788296f docs(doc/userguide.md): tweak Debian installation
Add note about `kvm` kernel module and Unix group.

Add step to create log directory.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-05-21 18:21:37 +03:00
Lars Wirzenius 941343071d Revert "docs(doc/install.md): oops, add the installation document to Git"
This reverts commit 5ae86e9103.

The doc is part of the user guide already, no need to have it as a
separate file as well. It'll just get out of sync.
2025-05-19 11:24:54 +03:00
Lars Wirzenius 5ae86e9103 docs(doc/install.md): oops, add the installation document to Git
Had forgotten to add that. Bummer.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-05-19 10:56:52 +03:00
Lars Wirzenius 4e5dbdae20 docs(doc/userguide.md): add detailed installation guide for Debian
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-05-15 15:54:28 +03:00
Lars Wirzenius 6c14e56371 Merge branch 'patch/9437534' 2025-05-14 13:37:02 +03:00
Lars Wirzenius 93177407b4 docs(doc/architecture.md): update architecture components
Have just one component description, instead of separating "external"
and "native CI". Native CI doesn't need t be mentioned anyway.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-05-13 10:24:51 +03:00
Lars Wirzenius 5ce95bc360 feat: add "concurrent_adapters" to configuration file
This doesn't yet affect anything, but it's a step towards implementing
concurrent adapters. The default is 1, which will be no change from
previous behavior, once I add support.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-05-13 09:02:12 +03:00
Tshepang Mbambo 1d4442d42f avoid confusing terminology
Got confused here, where I did not know if what was referred was the
normal node or the CI node.

Also, "seed node" is used elsewhere to refer to nodes which need to
remain online.
2025-05-13 08:58:27 +03:00
Tshepang Mbambo b80a97d146 typo 2025-05-02 23:55:09 +02:00
Lars Wirzenius 6ec75d1978 doc(doc/userguide.md): document new tag events and filters
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-04-04 11:51:04 +03:00
Lars Wirzenius 6dc057e27f doc: add a "Getting started" section to the user guide
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-03-31 15:46:41 +03:00
Lars Wirzenius 0d1d3291cc fix: use new Git refs module, fix bugs found
This is a huge change, but it's mostly a few kinds of similar changes
in a lot of places. Unfortunately, they were not easy to tease apart
into small, easily reviewed commits.

Use the Git ref types created by the new refs module. Fix problems
this exposes.

The CiEvent enum variants for branch events now use the BranchName
type for branch names. In other words, they have a plain branch name.
The CiEvent::from_node_event constructor also always sets the branch
name to a plain branch name, instead of a name spaced ref for updated
or deleted branches. The ci_event.rs module's unit tests have been
fixed to use the correct kind of Git ref in each test. (It used to be
a mess.)

The CI event filter "Branch" now contains a BranchName, previously a
RefString. This should not break anything, as a RefString will always
work as a BranchName.

The DefaultBranch filter now works, because it compares plain branch
names, where it previously would compare a plain and a name spaced
branch name, and those are never equal.

"cibtool trigger" and "cibtool event add" now add branch events with a plain
branch instead of a name spaced ref.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-03-20 18:33:39 +02:00
Lars Wirzenius b0adc805ec doc(doc/userguide.md): add a chapter on configuration
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-03-13 18:03:06 +02:00
Lars Wirzenius a01aa8ce49 doc(doc/userguide.md): add DefaultBranch, HasFile, NoneOf, AnyOf, AllOf
Also sort table alphabetically, for easier skimming.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-02-18 15:55:31 +02:00
Lars Wirzenius 25a8d24d30 docs(doc/userguide.md): document "triggers" feature
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2025-01-23 18:20:22 +02:00
Lars Wirzenius dc61d2bbbb doc: reorder sections so that the more general case comes first
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2024-11-13 09:47:26 +02:00
Lars Wirzenius 92cbd0c730 doc: add goals to CI architecture doc
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2024-11-13 09:47:26 +02:00
Lars Wirzenius b199175ac0 doc: generate sample adapter messages with code
This removes the need to update them manually. Now they'll always be
up to date.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2024-11-13 09:47:26 +02:00
Lars Wirzenius 7ddb877a15 doc: format with Subplot, improve text
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2024-11-13 09:47:22 +02:00
Lars Wirzenius d537fd39d1 feat: filter on originating node for an event
Add the `Node(nid)` event filter.

Add the `from_node` field to the `BranchDeleted` event so that it too
can be filtered based on node.

Adjust debug logging for event filtering so that it reports the
filtering decision.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2024-10-21 14:07:11 +03:00
Lars Wirzenius 69f10e3eb2 docs: start user guide; document CI events and filters 2024-09-30 14:01:03 +03:00
Richard Levitte 1a46a855e1 doc: RefsUpdated → RefsFetched
Since that's what's actually looked at (and RefsUpdated isn't an existing
type anyway).
2024-09-17 17:43:15 +02:00
Lars Wirzenius 9c822c67d2 docs: always publish
This works around a limitation in the native CI adapter, which checks
out the commit, but doesn't tell the CI run from which branch it came
from.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2024-05-14 16:34:20 +03:00
Lars Wirzenius 98db404e73 docs: move publishing shell snippet out of Makefile
Makefiles are an extra layer of escaping that doesn't help.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2024-05-14 16:26:46 +03:00
Lars Wirzenius b165bf3d96 docs: be more verbose to ease debugging
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2024-05-14 16:16:24 +03:00
Lars Wirzenius 9580c3e6b8 fix: conditions for publishing arch doc
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2024-05-14 16:12:06 +03:00
Lars Wirzenius 8809b09c9a chore: build and optionally publish documentation
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2024-05-14 16:00:58 +03:00
Michalis Zampetakis a8a9946836 Remove error response 2024-04-12 16:17:12 +03:00
Michalis Zampetakis e342d614cb Update docs with procol version and failure 2024-04-12 16:17:12 +03:00
Lars Wirzenius 30c7d59e68 docs: bring architecture document up to date
Various updates to bring the text of the architecture document up to
date with what has been implemented. Most of the speculative "we will
probably do it like this" parts have been dropped. Various fixes have
been made.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2024-03-18 15:58:07 +02:00
Michalis Zampetakis 472ca9ba8a Adds branch name for push events 2024-03-05 12:55:06 +02:00
Lars Wirzenius 2dafe88a84 fix: list formatting
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2024-02-16 14:18:37 +02:00
Lars Wirzenius 729e054222 fix: formatting of list
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2024-02-16 14:16:44 +02:00
Lars Wirzenius 24fb53b395 docs: clarify wording
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2024-02-16 13:54:54 +02:00
Michalis Zampetakis e11a62ead1 Fix some letter casing in doc/architecture.md 2023-12-22 13:28:35 +02:00
Lars Wirzenius 0c6ce32472 Merge branch 'patch/df4563f' 2023-12-18 20:07:39 +02:00
Yorgos Saslis a00212538b enriches broker request payload to enable complex workflows in external CI
Signed-off-by: Yorgos Saslis <yorgo@proton.me>
2023-12-18 19:42:39 +02:00
Yorgos Saslis 93654fa547 fixes config path
Signed-off-by: Yorgos Saslis <yorgo@proton.me>
2023-12-18 19:42:38 +02:00
Lars Wirzenius a4047dc968 feat: more flexible filtering
Add filters on a specific branch, any patch, a specific branch, and
allow combining filters with AND, OR, NOT, and document the motivation
for each of these in requirements.md.

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2023-12-18 18:58:36 +02:00
Lars Wirzenius cd86193927 docs: add initial architecture document and diagrams
Signed-off-by: Lars Wirzenius <liw@liw.fi>
2023-12-06 13:17:14 +02:00