Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add publishing steps to book #422

Merged
merged 2 commits into from
May 5, 2020
Merged

Add publishing steps to book #422

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
471cd39
Add publishing steps
jackh726 Apr 30, 2020
3b22b6c
Give example of tag
jackh726 May 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions book/src/SUMMARY.md
View file
Open in desktop
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
View file
Open in desktop
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`)