Skip to content

Commit

Permalink
[ci skip] 2024.11.05-32272
Browse files Browse the repository at this point in the history
  • Loading branch information
cybozu-neco committed Nov 5, 2024
2 parents c3354b8 + 227a39b commit a6dafaf
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 24 deletions.
18 changes: 3 additions & 15 deletions docs/artifacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,14 @@ Artifacts

[Artifacts](../artifacts.go) is the collection of components tested in [dctest](../dctest/), which consists of container images, debian package, and Flatcar image.

There are two artifacts files. When generating neco binaries and the neco deb package, `artifacts.go` is used
by default. `artifacts_release.go` is used only when `release` build tag is given.
There is one artifacts file. When generating neco binaries and the neco deb package, `artifacts.go` is used by default.

- [artifacts.go](../artifacts.go)

This file describes artifacts to be tested in development.
This file describes artifacts which is used while development or CI before build neco binaries.
It should be updated with `generate-artifacts` command.
You may edit the file **ONLY IF** you would like to test different combination of components.

- [artifacts_release.go](../artifacts.go)

This file is for CI. The CI job updates this file by using
`generate-artifacts --release`.

The developers are PROHIBITED to modify this file. This is to prevent
merge conflicts in CI flow.

This file exists only in the `release` branch.

## How to handle prerelease versions

As described above, you should not edit artifacts files manually in general.
Expand All @@ -31,8 +20,7 @@ A component with prerelease version information, i.e. x.y.z-\<prerelease\>,
does not get included in artifacts files by `generate-artifacts`.
So if you want to use such a component, include it manually.
Though you can edit `artifacts.go` in this case, you must not merge it into
the main branch anyway, because that component does not get included in
`artifacts_release.go` and CI on `release` branch will fail.
the main branch because prerelease version is unstable and may not be compatible with other the associated regular versions.
Instead, after you confirm that neco can accept a component of x.y.z-\<prerelease\>,
release the component as x.y.z and include it in artifacts files by `generate-artifacts`.

Expand Down
9 changes: 4 additions & 5 deletions docs/cicd.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,10 @@ CI flow

### After `main` merge

1. Run `generate-artifacts` to retrieve latest version of components, then generate `artifacts_release.go`.
2. Check out `main` branch then merge changes into `release` branch.
3. Run [dctest][] but fewer test cases from regular dctest.
4. If dctest is passed, [cybozu-neco][] pushes changes to `release` branch to remote branch in [github.com/cybozu-go/neco](https://github.com/cybozu-go/neco).
5. Also, [cybozu-neco][] also applies and pushes a tag `test-YYYY.MM.DD-UNIQUE_ID` to the remote.
1. Check out `main` branch then merge changes into `release` branch.
2. Run [dctest][] but fewer test cases from regular dctest.
3. If dctest is passed, [cybozu-neco][] pushes changes to `release` branch to remote branch in [github.com/cybozu-go/neco](https://github.com/cybozu-go/neco).
4. Also, [cybozu-neco][] also applies and pushes a tag `test-YYYY.MM.DD-UNIQUE_ID` to the remote.

Regular test cases of dctest are also run in parallel.

Expand Down
5 changes: 1 addition & 4 deletions docs/dctest.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,10 +113,7 @@ This variable makes sense only when `SUITE=bootstrap` is specified.

### `TAGS`

You can choose the list of artifacts by specifying `TAGS` make variable,
though non-default value is only for CI.
The default is to use `artifacts.go`.
Specify `TAGS=release` in the release branch to use `artifacts_release.go`.
This variable is not currently in use.

`make test` accepts this variable.

Expand Down

0 comments on commit a6dafaf

Please sign in to comment.