Skip to content

Commit

Permalink
Merge pull request #364 from WilhelmusLab/update-release-0.4.2
Browse files Browse the repository at this point in the history
update: add versioning instructions
  • Loading branch information
cpaniaguam authored Apr 2, 2024
2 parents d37df4e + f0eef4a commit 0fde544
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
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 <bradford_roarr@brown.edu> 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

2 comments on commit 0fde544

@cpaniaguam
Copy link
Member Author

Choose a reason for hiding this comment

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

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

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

Registration pull request created: JuliaRegistries/General/104090

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.4.2 -m "<description of version>" 0fde544bbf6b7cab857771c88b28e9ad1b39f33e
git push origin v0.4.2

Please sign in to comment.