Skip to content

Commit

Permalink
chore: Update eksup version prior to release
Browse files Browse the repository at this point in the history
  • Loading branch information
bryantbiggs committed Oct 4, 2023
1 parent 274b129 commit 82bddfa
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 9 deletions.
12 changes: 7 additions & 5 deletions .github/RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,18 @@

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.
1. Update the version of `eksup` used throughout the project as well as within `Cargo.toml`. Commit the changes and push to `main` before publishing the new version. This is due to the version being embedded in the resulting executable.

2. 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. 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).
4. 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
Expand All @@ -20,13 +22,13 @@ This document captures the steps to follow when releasing a new version of `eksu
git push origin main
```

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

```sh
mkdocs gh-deploy
```

5. Update package on crates.io. Update the version of `eksup` used throughout the project as well as within `Cargo.toml`. Commit the changes and push to `main` before publishing the new version to crates.io.
6. Update package on crates.io.

```sh
cd eksup
Expand Down
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ git clone https://github.com/clowdhaus/eksup
cd eksup
cargo build --release
./target/release/eksup --version
0.3.3
0.4.0
```

## Local Development
Expand Down
2 changes: 1 addition & 1 deletion eksup/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "eksup"
version = "0.3.3"
version = "0.4.0"
authors = ["Bryant Biggs <[email protected]>"]
description = "A CLI to aid in upgrading Amazon EKS clusters"
documentation = "https://github.com/clowdhaus/eksup"
Expand Down
2 changes: 1 addition & 1 deletion eksup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ git clone https://github.com/clowdhaus/eksup
cd eksup
cargo build --release
./target/release/eksup --version
0.3.3
0.4.0
```

## Local Development
Expand Down

0 comments on commit 82bddfa

Please sign in to comment.