2024-03-05 11:08:55 -08:00
|
|
|
# Release Instructions
|
|
|
|
|
|
2024-08-20 13:11:34 -05:00
|
|
|
Follow the steps below to tag a new release for the `actions/attest-sbom`
|
|
|
|
|
action.
|
2024-03-05 11:08:55 -08:00
|
|
|
|
2024-08-20 13:11:34 -05:00
|
|
|
If changes were made to the internal `actions/attest-sbom/predicate` action (any
|
|
|
|
|
updates to [`./predicate/action.yaml`](./predicate/action.yml) or any of the
|
|
|
|
|
code in the [`./src`](./src) directory), start with step #1; otherwise, skip
|
|
|
|
|
directly to step #5.
|
2024-03-05 11:08:55 -08:00
|
|
|
|
|
|
|
|
1. Merge the latest changes to the `main` branch.
|
|
|
|
|
1. Create and push a new predicate tag of the form `predicate@X.X.X` following
|
|
|
|
|
SemVer conventions:
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
git tag -a "predicate@X.X.X" -m "predicate@X.X.X Release"
|
|
|
|
|
git push --tags
|
|
|
|
|
```
|
|
|
|
|
|
2024-08-20 13:11:34 -05:00
|
|
|
1. Update the reference to the `actions/attest-sbom/predicate` action in
|
|
|
|
|
[`action.yml`](./action.yml) to point to the SHA of the newly created tag.
|
2024-03-05 11:08:55 -08:00
|
|
|
1. Push the `action.yml` change and open a PR. Once it has been reviewed, merge
|
|
|
|
|
the PR and proceed with the release instructions.
|
|
|
|
|
1. Create a new release for the top-level action using a tag of the form
|
|
|
|
|
`vX.X.X` following SemVer conventions:
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
gh release create vX.X.X
|
|
|
|
|
```
|
2024-05-10 10:48:50 -07:00
|
|
|
|
|
|
|
|
1. Move (or create) the major version tag to point to the same commit tagged
|
|
|
|
|
above:
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
git tag -fa vX -m "vX"
|
|
|
|
|
git push origin vX --force
|
|
|
|
|
```
|