Merge pull request #422 from jackh726/release-docs

Add publishing steps to book

Author: jackh726

book/src/SUMMARY.md

@@ -31,3 +31,4 @@
 [Appendix A: Glossary and terminology](./glossary.md)
 [Appendix B: Bibliography](./bibliography.md)
 [Appendix C: Incomplete chapters](./todo.md)
+[Appendix D: Publishing Chalk](./publishing.md)

book/src/publishing.md

@@ -0,0 +1,34 @@
+# Publishing Chalk
+
+**Note: this is mostly only useful for maintainers**
+
+The following crates get published to crates.io:
+- `chalk-macros`
+- `chalk-derive`
+- `chalk-engine`
+- `chalk-ir`
+- `chalk-rust-ir`
+- `chalk-solve`
+
+The following crates get versioned without publishing:
+- `chalk-parse`
+- `chalk-integration`
+- `chalk` (root directory)
+
+## Pre-publish
+- Remove the `-dev` suffix from the versions in each `cargo.toml`
+- Bump the dependency version for each crate
+- Change the `Unreleased` section in `RELEASES.md` to the version getting published
+- Create commit
+
+## Publishing
+- For each crate in the order above, run `cargo publish`
+    - You will probably have to wait a couple seconds between each to let the index update
+
+## Post-publish
+- Bump the minor version in each `cargo.toml` and add a `-dev` suffix
+- Bump the dependency version for each crate
+- Add an `Unreleased` section in the `RELEASES.md`
+- Run `cargo check`
+- Tag release commit on github (e.g. `v0.10.0`)
+