-
Notifications
You must be signed in to change notification settings - Fork 183
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #422 from jackh726/release-docs
Add publishing steps to book
- Loading branch information
Showing
2 changed files
with
35 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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`) | ||
|