From 8180e3961658986b0c9da0f88b76c51d8b1334ff Mon Sep 17 00:00:00 2001 From: Timothy Divoll Date: Tue, 2 Apr 2024 13:09:59 -0400 Subject: [PATCH 1/2] update: add versioning instructions --- Project.toml | 2 +- README.md | 15 ++++++++++++++- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/Project.toml b/Project.toml index ddf5f9db..c4102ed9 100644 --- a/Project.toml +++ b/Project.toml @@ -1,7 +1,7 @@ name = "IceFloeTracker" uuid = "04643c7a-9ac6-48c5-822f-2704f9e70bd3" authors = ["bradford roarr and contributors"] -version = "0.4.1" +version = "0.4.2" [deps] AxisArrays = "39de3d68-74b9-583c-8d2d-e117c070f3a9" diff --git a/README.md b/README.md index 9608e724..8c3e33c5 100644 --- a/README.md +++ b/README.md @@ -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 -``` \ No newline at end of file +``` + +### Versioning the registered package + +1. Update the major or minor version numbers at the top of `Project.toml` +2. Add `@JuliaRegistrator register` in a comment on your PR + - this bot will open a PR on the [Julia register](https://github.com/JuliaRegistries/General/tree/master/I/IceFloeTracker) +3. Check the Julia register to make sure the version is accepted and merged +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 \ No newline at end of file From f0eef4aeef0f9c4bee1a96495b602f9655da817a Mon Sep 17 00:00:00 2001 From: Carlos Paniagua Date: Tue, 2 Apr 2024 13:38:56 -0400 Subject: [PATCH 2/2] Update README.md docs: review changes --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8c3e33c5..d0ff3dc2 100644 --- a/README.md +++ b/README.md @@ -69,13 +69,13 @@ git push ### Versioning the registered package -1. Update the major or minor version numbers at the top of `Project.toml` -2. Add `@JuliaRegistrator register` in a comment on your PR - - this bot will open a PR on the [Julia register](https://github.com/JuliaRegistries/General/tree/master/I/IceFloeTracker) -3. Check the Julia register to make sure the version is accepted and merged +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 + - 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 \ No newline at end of file + - Click on `Generate release notes` or add a custom description