Skip to content

Commit

Permalink
docs: Document release process for future self
Browse files Browse the repository at this point in the history
  • Loading branch information
bryantbiggs committed Feb 16, 2023
1 parent 2317e20 commit 8e3fb1b
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .github/RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Release Process

This document captures the steps to follow when releasing a new version of `eksup`. In the future, some or all of these steps may be automated.

1. Create a new tag on `main` with the new version number.

```sh
git tag -a v0.1.0 -m "Release v0.1.0"
git push origin v0.1.0
```

2. This will kick off a GitHub Actions workflow that will publish the GitHub release, and start building the various release artifacts. As the artifacts finish building, they will be attached to the release automatically by the workflow.

3. Once the release is published, update the Homebrew tap formula to point to the new release using the script provided in the tap reposiotry. The tap formula is located at [homebrew-taps](https://github.com/clowdhaus/homebrew-taps).

```sh
./update_sha256.sh eksup v0.1.0
git add --a
git commit -m 'feat: Update eksup to v0.1.0'
git push origin main
```

4. Update the `eksup` documentation site to ensure any changes have been synced with the documetnation. This is done from within the `eksup` repository.

```sh
mkdocs gh-deploy
```
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,6 @@ target
*.profdata
tarpaulin*.json
tarpaulin-report.html

# Mkdocs site
site

0 comments on commit 8e3fb1b

Please sign in to comment.