Skip to content

Commit 1427c3c

Browse files
committed
More Changelog changes.
1 parent b68c258 commit 1427c3c

File tree

2 files changed

+17
-12
lines changed

2 files changed

+17
-12
lines changed

README.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,7 @@ This is an export of [`rustdoc-json-types`](https://github.com/rust-lang/rust/bl
99
1. Run `./update.sh` to pull code from upstream
1010
2. Run `cargo test`
1111
3. Run `./clgen.sh <old_version> <new_version>`
12-
4. Edit the `TODO` section in `CHANGELOG.md` to include what was done in this release.
13-
5. `git add .`
14-
6. `git commit -m v<new_version>`
15-
7. `cargo publish`
16-
8. `git tag v<new_version>`
17-
9. `git push`
18-
10. `git push --tags`
19-
20-
12+
4. Follow instructions to commit and push.
2113

2214
## License
2315

clgen.sh

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,18 +38,31 @@ format_version=$(cat src/lib.rs | grepor FORMAT_VERSION | col6 | sd ";" "")
3838
rustc_commit=$(cat COMMIT.txt)
3939

4040
# We do a shuffling dance to append the new version to the top of the changelog
41+
new_tag="v$new_version"
42+
old_tag="v$old_version"
43+
4144
cat<<EOF > tmp
42-
<a name="$new_version"></a>"
43-
# [$new_version](https://github.com/aDotInTheVoid/rustdoc-types/releases/tag/$new_version) - $date"
45+
<a name="$new_tag"></a>"
46+
# [$new_tag](https://github.com/aDotInTheVoid/rustdoc-types/releases/tag/$new_tag) - $date"
4447
4548
TODO: Changelog.
4649
4750
- Format Version: $format_version
4851
- Upstream Commit: [\`$rustc_commit\`](https://github.com/rust-lang/rust/commit/$rustc_commit)"
49-
- Diff: [$new_version...$new_version](https://github.com/aDotInTheVoid/rustdoc-types/compare/$old_version...$new_version)"
52+
- Diff: [$old_tag...$new_tag](https://github.com/aDotInTheVoid/rustdoc-types/compare/$old_tag...$new_tag)"
53+
5054
EOF
5155

5256
cat tmp CHANGELOG.md > tmp2
5357
mv tmp2 CHANGELOG.md
5458
rm tmp
5559

60+
61+
echo "First, edit the TODO in CHANGELOG.md"
62+
echo "Then, check the diff"
63+
echo "Finaly Run:"
64+
echo "git add Cargo.toml CHANGELOG.md COMMIT.txt src/"
65+
echo "git commit -m $new_version"
66+
echo "git tag $new_tag"
67+
echo "git push && git push --tags"
68+
echo "cargo publish"

0 commit comments

Comments
 (0)