Skip to content

Commit

Permalink
add release docs (#500)
Browse files Browse the repository at this point in the history
Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>
  • Loading branch information
wagoodman authored Oct 11, 2024
1 parent 4a914bc commit 2e87236
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Release

A release of sbom-action comprises:
- a new semver git tag from the current tip of the main branch
- a new [github release](https://github.com/anchore/sbom-action/releases) with a changelog
- the action distributable committed into the repo at `dist/`

Ideally releasing should be done often with small increments when possible. Unless a
breaking change is blocking the release, or no fixes/features have been merged, a good
target release cadence is between every 1 or 2 weeks.


## Creating a release

Releases are automatically drafted on every push to the main branch. Please see the [github releases page](https://github.com/anchore/sbom-action/releases) for the latest draft. To publish the release:

- Click "edit" (the pencil icon)
- Modify the changelog as needed (for instance, if syft was bumped multiple times, include only the latest version bump entry)
- Click "publish"

0 comments on commit 2e87236

Please sign in to comment.