Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update: add versioning instructions #364

Merged
merged 2 commits into from
Apr 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "IceFloeTracker"
uuid = "04643c7a-9ac6-48c5-822f-2704f9e70bd3"
authors = ["bradford roarr <[email protected]> and contributors"]
version = "0.4.1"
version = "0.4.2"

[deps]
AxisArrays = "39de3d68-74b9-583c-8d2d-e117c070f3a9"
Expand Down
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,17 @@ To help with passing git hooks, run the formatting script before staging files:
git add .
git commit -m "some informative message"
git push
```
```

### Versioning the registered package

1. Update the major or minor version numbers in the corresponding field at the top of `Project.toml`
2. Add `@JuliaRegistrator register` in a comment in the commit you wish to use for the release
- this bot will open a PR on the [Julia registry](https://github.com/JuliaRegistries/General/tree/master/I/IceFloeTracker) for the package
3. Wait for feedback from the bot to make sure the new version is accepted and merged to the Julia registry
4. Create a new version tag
- The bot will generate git commands that you can run in a terminal to add a tag
5. Create the new release on the [repo console](https://github.com/WilhelmusLab/IceFloeTracker.jl/releases)
- Click on `Draft a new release`
- Choose the new tag you created
- Click on `Generate release notes` or add a custom description
Loading