Skip to content

Commit

Permalink
add release instructions (#21)
Browse files Browse the repository at this point in the history
Signed-off-by: Brian DeHamer <bdehamer@github.com>
  • Loading branch information
bdehamer committed Mar 5, 2024
1 parent 05284cc commit 48e5743
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 59 deletions.
30 changes: 30 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Release Instructions

Follow the steps below to tag a new release for the
`actions/attest-sbom` action.

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.

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
```

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.
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
```
59 changes: 0 additions & 59 deletions script/release

This file was deleted.

0 comments on commit 48e5743

Please sign in to comment.