@@ -6,27 +6,30 @@ The following crates get published to crates.io:
6
6
- ` chalk-derive `
7
7
- ` chalk-engine `
8
8
- ` chalk-ir `
9
+ - ` chalk-recursive `
9
10
- ` chalk-solve `
10
11
11
12
The following crates get versioned without publishing:
12
13
- ` chalk-parse `
13
14
- ` chalk-integration `
14
15
- ` chalk ` (root directory)
15
16
16
- ## Pre-publish
17
- - Remove the ` -dev ` suffix from the versions in each ` cargo.toml `
18
- - Bump the dependency version for each crate
19
- - Change the ` Unreleased ` section in ` RELEASES.md ` to the version getting published
20
- - Create commit
17
+ ## Release Automation
18
+ Releases are fully automated. Once a week (Sunday at midnight UTC) a GitHub
19
+ Actions job is executed which generates the changelog, bumps crate versions, and
20
+ publishes the crates. If there have not been any changes since the last version,
21
+ the release is skipped. However, if the job is manually triggered then the
22
+ release will be published even if there are no changes.
21
23
22
- ## Publishing
23
- - For each crate in the order above, run ` cargo publish `
24
- - You will probably have to wait a couple seconds between each to let the index update
24
+ The release pipeline is located in [ ` publish.yml ` ] .
25
25
26
- ## Post-publish
27
- - Bump the minor version in each ` cargo.toml ` and add a ` -dev ` suffix
28
- - Bump the dependency version for each crate
29
- - Add an ` Unreleased ` section in the ` RELEASES.md `
30
- - Run ` cargo check `
31
- - Tag release commit on github (e.g. ` v0.10.0 ` )
26
+ [ `publish.yml` ] : https://github.com/rust-lang/chalk/blob/master/.github/workflows/publish.yml
32
27
28
+ ### Changelog Generation
29
+ The changelog is generated using [ ` auto-changelog ` ] and is stored in
30
+ [ ` RELEASES.md ` ] . The template used for the changelog is in
31
+ [ ` releases-template.hbs ` ] .
32
+
33
+ [ `auto-changelog` ] : https://www.npmjs.com/package/auto-changelog
34
+ [ `RELEASES.md` ] : https://github.com/rust-lang/chalk/blob/master/RELEASES.md
35
+ [ `releases-template.hbs` ] : https://github.com/rust-lang/chalk/blob/master/releases-template.hbs
0 commit comments