Skip to content

Commit

Permalink
Add notes on releasing
Browse files Browse the repository at this point in the history
jonatanklosko committed Jan 28, 2025
1 parent e6652b4 commit 0eed552
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -368,6 +368,23 @@ For Windows, run:
.github/scripts/app/build_windows.sh
```

## Release

0. If applicable, release Kino first and update built-in notebooks to reference
the new version.
1. Make sure the latest CI "Assets" workflow finished.
2. Switch to (or create) vx.y branch.
3. If applicable cherry-pick the relevant commits from main onto the vx.y branch.
1. If you do that, push, wait for CI "Assets" workflow to finish, and pull.
3. Update version in `mix.exs` and finish changelog.
4. Run `mix hex.build` as a sanity check.
5. `git tag vx.y.z`, `git push --tags`
1. Wait for CI to finish (Docker and Desktop)
6. Run `mix hex.publish`.
7. Publish GH release with copied changelog notes.
8. If you crated branch in step 2., update main changelog to point to
the branch and bump version in mix.exs (with `-dev` suffix).

## Platinum sponsors

<a href="https://fly.io">

1 comment on commit 0eed552

@hugobarauna
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️ 🧡 💛 💚 💙 💜 🤎 🖤 🤍

Please sign in to comment.