Skip to content

Commit a18ff2d

Browse files
authored
add release docs (#388)
Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>
1 parent c6c022e commit a18ff2d

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

RELEASE.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Release
2+
3+
A release of scan-action comprises:
4+
- a new semver git tag from the current tip of the main branch
5+
- a new [github release](https://github.com/anchore/scan-action/releases) with a changelog
6+
- the action distributable committed into the repo at `dist/`
7+
8+
Ideally releasing should be done often with small increments when possible. Unless a
9+
breaking change is blocking the release, or no fixes/features have been merged, a good
10+
target release cadence is between every 1 or 2 weeks.
11+
12+
13+
## Creating a release
14+
15+
Releases are automatically drafted on every push to the main branch. Please see the [github releases page](https://github.com/anchore/scan-action/releases) for the latest draft. To publish the release:
16+
17+
- Click "edit" (the pencil icon)
18+
- Modify the changelog as needed (for instance, if grype was bumped multiple times, include only the latest version bump entry)
19+
- Click "publish"

0 commit comments

Comments
 (0)