Update backport, release and sync documentation #13700
Conversation
rustbot
added
the
S-waiting-on-review
| 1. [Defining Remotes](#defining-remotes) | ||
| 1. [Bump Version](#bump-version) | ||
| 1. [Find the Clippy commit](#find-the-clippy-commit) | ||
| 1. [Update the `beta` branch](#update-the-beta-branch) | ||
| 1. [Update the `stable` branch](#update-the-stable-branch) | ||
| 1. [Tag the stable commit](#tag-the-stable-commit) | ||
| 1. [Update `CHANGELOG.md`](#update-changelogmd) |
There was a problem hiding this comment.
| 1. [Defining Remotes](#defining-remotes) | |
| 1. [Bump Version](#bump-version) | |
| 1. [Find the Clippy commit](#find-the-clippy-commit) | |
| 1. [Update the `beta` branch](#update-the-beta-branch) | |
| 1. [Update the `stable` branch](#update-the-stable-branch) | |
| 1. [Tag the stable commit](#tag-the-stable-commit) | |
| 1. [Update `CHANGELOG.md`](#update-changelogmd) | |
| 1. [Defining Remotes](#defining-remotes) | |
| 2. [Bump Version](#bump-version) | |
| 3. [Find the Clippy commit](#find-the-clippy-commit) | |
| 4. [Update the `beta` branch](#update-the-beta-branch) | |
| 5. [Update the `stable` branch](#update-the-stable-branch) | |
| 6. [Tag the stable commit](#tag-the-stable-commit) | |
| 7. [Update `CHANGELOG.md`](#update-changelogmd) |
There was a problem hiding this comment.
MdBook renders the original source as a correctly ordered list, although it would be cool to have the numbered list even when reading source.
There was a problem hiding this comment.
I went with that, so when inserting a new chapter in the future, you don't have to update all the following numbers. But happy to change that.
| 1. [Defining Remotes](#defining-remotes) | ||
| 1. [Bump Version](#bump-version) | ||
| 1. [Find the Clippy commit](#find-the-clippy-commit) | ||
| 1. [Update the `beta` branch](#update-the-beta-branch) | ||
| 1. [Update the `stable` branch](#update-the-stable-branch) | ||
| 1. [Tag the stable commit](#tag-the-stable-commit) | ||
| 1. [Update `CHANGELOG.md`](#update-changelogmd) |
There was a problem hiding this comment.
MdBook renders the original source as a correctly ordered list, although it would be cool to have the numbered list even when reading source.
There was a problem hiding this comment.
Is there a reason to change the branch names? 🤔 I think those were fine.
There was a problem hiding this comment.
Yes. rustbot checks all PRs for merge commits and will comment on it, if it finds one. This can be opted out with allowing some PR titles to have merge commits:
Lines 12 to 15 in 8298da7
In the Clippy repo it is Rustup, in the Rust repo it is subtree update.
By using rustup as a branch name in the Clippy repo and clippy-subtree-update in the Rust repo, GitHub will automatically set the title when opening the PR to Rustup and Clippy subtree update respectively. So rustbot won't complain about these PRs.
|
@rustbot ready I addressed all comments in 9858a4e, except for #13700 (comment). LMK, if you want me to change that. I'll rebase+squash once the PR is approved. |
|
@rustbot author |
rustbot
added
S-waiting-on-author
flip1995
force-pushed
the
docs-update
branch
from
375026b to
f5f2c51
Compare
This updates the documentation after #13694. It is not based on that PR chain and can be merged independently, but should be merged after that PR.
This is partly pulled from #12762, but removing the Josh parts.
This includes instructions on how to publish
clippy_utils.Closes #13556 (yes, this is the final PR 🙂)
r? @blyxyas
changelog:
clippy_utilsis now published to crates.io