Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add release docs #500

Merged
merged 1 commit into from
Oct 11, 2024
Merged

Add release docs #500

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions RELEASE.md
View file
Open in desktop
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"
Loading