Add releasing docs (#16)

IronCoreLabs · Apr 25, 2024 · 4e209e5 · 4e209e5
1 parent cf5956d
commit 4e209e5
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,9 @@
+## 0.2.0
+
+Breaking changes:
+
+- Changed several functions to take RNG as `Arc<Mutex<R>>` instead of `&mut R`. This allows for these functions to be called concurrently.
+
+## 0.1.0
+
+- Initial release
diff --git a/RELEASING.md b/RELEASING.md
@@ -0,0 +1,14 @@
+# Release to GitHub
+
+- Make sure all changes to be released are on `main`
+- Compare `main`'s commit history to the changelog to ensure all public API changes are included as well as notable internal changes
+  - If necessary, PR and merge the changelog changes.
+- Run the [Bump Version](https://github.com/IronCoreLabs/ironcore-documents/actions/workflows/bump-version.yaml) workflow in this repo.
+  - Give it a new release version. For example, if the current version is 1.2.3-pre.4, type in 1.2.3.
+
+# Release to crates.io
+
+- `git checkout <tag>` where `<tag>` is the GitHub tag created by the Bump Version workflow above.
+- `cargo package` to see if there are any issues
+- `cargo publish`
+- Check crates.io and docs.rs sites for new version