Skip to content

Commit 7b44dec

Browse files
update README with release process doc
1 parent 444acee commit 7b44dec

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ jobs:
3131
- name: Create Release
3232
uses: softprops/action-gh-release@1e07f4398721186383de40550babbdf2b84acfc5
3333
env:
34-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
34+
GITHUB_TOKEN: ${{ secrets.TOKEN }}
3535
with:
3636
# uses the HEAD on the default branch when creating the tag
3737
tag_name: ${{ github.event.inputs.tag }}

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,20 @@ $ clusterlint --plugins=/path/to/plugin.so list
123123
$ clusterlint --plugins=/path/to/plugin.so run -c my-plugin-check
124124
```
125125

126+
## Release
127+
128+
To release a new version of clusterlint, go to the actions page on GitHub, click on `Run workflow`.
129+
Specify the new tag to create. Make sure the tag is prefixed with `v`.
130+
131+
The workflow does the following:
132+
133+
- Checks out the source code from the default branch
134+
- Login with dockerhub credentials specified as secrets
135+
- Builds the docker image digitalocean/clusterlint:<tag>
136+
- Pushes digitalocean/clusterlint:<tag> to dockerhub
137+
- Builds binaries for all archs and computes sha256 sums for each binary
138+
- Creates release and tags the latest commit on the default branch with the input tag specified when workflow is triggered
139+
126140
## Contributing
127141

128142
Contributions are welcome, in the form of either issues or pull requests. Please

0 commit comments

Comments
 (0)