Skip to content
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

Add a changelog to x.py #76617

Closed
jyn514 opened this issue Sep 11, 2020 · 1 comment · Fixed by #76626
Closed

Add a changelog to x.py #76617

jyn514 opened this issue Sep 11, 2020 · 1 comment · Fixed by #76626
Labels
A-contributor-roadblock Area: Makes things more difficult for new contributors to rust itself E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)

Comments

@jyn514
Copy link
Member

jyn514 commented Sep 11, 2020

This would make it easier to find and learn more about breaking changes (or even just new features). It would also give us something to point to after a change, especially for changes not large enough to need their own blog post on inside-rust.

I'm imagining it would go in src/bootstrap/CHANGELOG.md, following https://keepachangelog.com/.

@jyn514 jyn514 added E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) labels Sep 11, 2020
@jyn514
Copy link
Member Author

jyn514 commented Sep 11, 2020

As a related feature, x.py should say something when the version changes asking you to read the changelog. One possible idea is to have current-version = "x" at the top of config.toml and print a warning until you update it to the latest version.

@jyn514 jyn514 added the A-contributor-roadblock Area: Makes things more difficult for new contributors to rust itself label Sep 13, 2020
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this issue Sep 16, 2020
…acrum

Make the default stage for x.py configurable

This also allows configuring each sub-command individually.

Possibly rust-lang#76617 should land before this? I don't feel strongly either way, I don't mind waiting.

Closes rust-lang#76165.
r? @Mark-Simulacrum
bors added a commit to rust-lang-ci/rust that referenced this issue Sep 16, 2020
Make the default stage for x.py configurable

This also allows configuring each sub-command individually.

Possibly rust-lang#76617 should land before this? I don't feel strongly either way, I don't mind waiting.

Closes rust-lang#76165.
r? `@Mark-Simulacrum`
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this issue Sep 21, 2020
…acrum

Add a changelog for x.py and nag contributors until they read it

Add a changelog for x.py

- Add a changelog and instructions for updating it
- Use `changelog-seen` in `config.toml` and `VERSION` in bootstrap to determine whether the changelog has been read.  There's no way to tie reading the changelog to updating the version, so unfortunately they still have to update `config.toml` manually. Actually reading the changelog is optional, anyone can set `changelog-seen = N` without reading (although it's not recommended).
- Nag people if they haven't read the x.py changelog
  + Print message twice to make sure it's seen
- Give different error messages depending on whether the version needs to be updated or added

Closes rust-lang#76617
r? @Mark-Simulacrum
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this issue Sep 22, 2020
…acrum

Add a changelog for x.py and nag contributors until they read it

Add a changelog for x.py

- Add a changelog and instructions for updating it
- Use `changelog-seen` in `config.toml` and `VERSION` in bootstrap to determine whether the changelog has been read.  There's no way to tie reading the changelog to updating the version, so unfortunately they still have to update `config.toml` manually. Actually reading the changelog is optional, anyone can set `changelog-seen = N` without reading (although it's not recommended).
- Nag people if they haven't read the x.py changelog
  + Print message twice to make sure it's seen
- Give different error messages depending on whether the version needs to be updated or added

Closes rust-lang#76617
r? @Mark-Simulacrum
@bors bors closed this as completed in cbc5e4d Sep 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-contributor-roadblock Area: Makes things more difficult for new contributors to rust itself E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant