Skip to content

Commit

Permalink
More Changelog changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
aDotInTheVoid committed Dec 23, 2023
1 parent b68c258 commit 1427c3c
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 12 deletions.
10 changes: 1 addition & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,7 @@ This is an export of [`rustdoc-json-types`](https://github.com/rust-lang/rust/bl
1. Run `./update.sh` to pull code from upstream
2. Run `cargo test`
3. Run `./clgen.sh <old_version> <new_version>`
4. Edit the `TODO` section in `CHANGELOG.md` to include what was done in this release.
5. `git add .`
6. `git commit -m v<new_version>`
7. `cargo publish`
8. `git tag v<new_version>`
9. `git push`
10. `git push --tags`


4. Follow instructions to commit and push.

## License

Expand Down
19 changes: 16 additions & 3 deletions clgen.sh
Original file line number Diff line number Diff line change
Expand Up @@ -38,18 +38,31 @@ format_version=$(cat src/lib.rs | grepor FORMAT_VERSION | col6 | sd ";" "")
rustc_commit=$(cat COMMIT.txt)

# We do a shuffling dance to append the new version to the top of the changelog
new_tag="v$new_version"
old_tag="v$old_version"

cat<<EOF > tmp
<a name="$new_version"></a>"
# [$new_version](https://github.com/aDotInTheVoid/rustdoc-types/releases/tag/$new_version) - $date"
<a name="$new_tag"></a>"
# [$new_tag](https://github.com/aDotInTheVoid/rustdoc-types/releases/tag/$new_tag) - $date"
TODO: Changelog.
- Format Version: $format_version
- Upstream Commit: [\`$rustc_commit\`](https://github.com/rust-lang/rust/commit/$rustc_commit)"
- Diff: [$new_version...$new_version](https://github.com/aDotInTheVoid/rustdoc-types/compare/$old_version...$new_version)"
- Diff: [$old_tag...$new_tag](https://github.com/aDotInTheVoid/rustdoc-types/compare/$old_tag...$new_tag)"
EOF

cat tmp CHANGELOG.md > tmp2
mv tmp2 CHANGELOG.md
rm tmp


echo "First, edit the TODO in CHANGELOG.md"
echo "Then, check the diff"
echo "Finaly Run:"
echo "git add Cargo.toml CHANGELOG.md COMMIT.txt src/"
echo "git commit -m $new_version"
echo "git tag $new_tag"
echo "git push && git push --tags"
echo "cargo publish"

0 comments on commit 1427c3c

Please sign in to comment.