Skip to content

Commit

Permalink
Merge pull request #422 from jackh726/release-docs
Browse files Browse the repository at this point in the history
Add publishing steps to book
  • Loading branch information
jackh726 authored May 5, 2020
2 parents e8b6a6a + 3b22b6c commit 47e1da6
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 0 deletions.
1 change: 1 addition & 0 deletions book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
34 changes: 34 additions & 0 deletions book/src/publishing.md
Original file line number Diff line number Diff line change
@@ -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`)

0 comments on commit 47e1da6

Please sign in to comment.