Bump version and release (#128)

* @JuliaRegistrator register() * @JuliaRegistrator register() @JuliaRegistrator register()
RelationalAI · Sep 3, 2024 · c6fe019 · c6fe019 · rbvermaa · Sep 3, 2024
1 parent 6c477a7
commit c6fe019
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/Project.toml b/Project.toml
@@ -1,6 +1,6 @@
 name = "RAI"
 uuid = "9c30249a-7e08-11ec-0e99-a323e937e79f"
-version = "0.2.8"
+version = "0.2.9"
 
 [deps]
 ArgParse = "c7e460c6-2fb9-53a9-8c5b-16f535851c63"

diff --git a/README.md b/README.md
@@ -53,6 +53,21 @@ line, eg:
 $ julia --project=. examples/list-engines.jl
 ```
 
+### Releases
+
+- Link to detailed instructions [Julia Registrator](https://github.com/JuliaRegistries/Registrator.jl?tab=readme-ov-file#via-the-github-app)
+
+The procedure for registering a new package is the same as for releasing a new version.
+If the registration bot is not added to the repository, `@JuliaRegistrator` register will not result in package registration.
+
+ Quick Summary:
+
+1. Set the `(Julia)Project.toml` version field in your repository to your new desired `version`.
+2. Comment `@JuliaRegistrator register()` on the commit/branch you want to register (e.g. like [here](https://github.com/JuliaRegistries/Registrator.jl/issues/61#issuecomment-483486641) or [here](https://github.com/chakravala/Grassmann.jl/commit/3c3a92610ebc8885619f561fe988b0d985852fce#commitcomment-33233149)).
+3. If something is incorrect, adjust, and redo step 1
+4. If the automatic tests pass, but a moderator makes suggestions (e.g., manually updating your `(Julia)Project.toml` to include a [compat] section with version requirements for dependencies), then incorporate suggestions as you see fit into a new commit, and redo step 2 for the new commit. You don't need to do anything to close out the old request.
+5. Finally, either rely on the [TagBot GitHub Action](https://github.com/marketplace/actions/julia-tagbot) to tag and make a github release or alternatively tag the release manually.
+
 ## Support
 
 You can reach the RAI developer support team at `[email protected]`