-
Notifications
You must be signed in to change notification settings - Fork 12.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Split RELEASES.md into new "2021 edition" file #118280
Conversation
(rustbot has picked a reviewer for you, use r? to override) |
7a90e45
to
c986c5d
Compare
This comment has been minimized.
This comment has been minimized.
Uh. I guess there's some ignore file I should add this to? |
Apparently the It could be that RELEASE.md is in an ignore list, either hardcoded in Anybody know what's going on? |
To ensure that splitting the file didn't break formatting, I ran the following commands: ```sh pulldown-cmark <RELEASES_2021_EDITION.md >rendered_2021.html pulldown-cmark <RELEASES.md >rendered.html diff rendered.html rendered_2021.html | rg "^>" ``` At first the diff included multiple new lines in `rendered_2021.html`, indicating links that weren't rendered to HTML because their target was missing. After I added those targets, but diff was remove-only. The general policy for RELEASES files would be to update the _2021 file until edition 2024 comes, then we'd create a RELEASES_2021_EDITION file (also linked from the RELEASES.md file), and so on. We could optionally add a RELEASES_2018_EDITION and/or a RELEASES_OLD file, but that decision is outside the scope of this commit.
c986c5d
to
b7b3d27
Compare
I've added RELEASES_2021_EDITION.md to the |
The job Click to see the possible cause of the failure (guessed by this bot)
|
Not sure how to fix this error. I could change the link to I could remove the link altogether until the PR is merged, then add it back in a following PR. |
I'm going to close this for now -- the current planned solution is rendering the release notes ourselves (via #117888). That is already merged & working, and once it hits stable we'll probably update our automation to link to that instead of the GitHub rendered view for future releases. |
Split RELEASES.md into new RELEASES_2021_EDITION.md file
To ensure that splitting the file didn't break formatting, I ran the
following commands:
At first the diff included multiple new lines in
rendered_2021.html
,indicating links that weren't rendered to HTML because their target was
missing. After I added those targets, but diff was remove-only.
The general policy for RELEASES files would be to update the _2021
file until edition 2024 comes, then we'd create a RELEASES_2021_EDITION
file (also linked from the RELEASES.md file), and so on.
We could optionally add a RELEASES_2018_EDITION and/or a RELEASES_OLD
file. Whether we should do that is outside the scope of this PR
(and I'd appreciate if we could avoid bikeshedding it here).