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

Prepare clippy_utils README and Cargo.toml for publishing #13693

Merged
merged 1 commit into from
Nov 17, 2024

Conversation

flip1995
Copy link
Member

@flip1995 flip1995 commented Nov 15, 2024

Follow up to #13691

Adds metadata to the clippy_utils/Cargo.toml, which is mostly copied from the root Cargo.toml.
Adds a README.md file listing the nightly version clippy_utils can be used with, mentions that there are no stability guarantees and the license.

The next PR will add automation to update the nightly toolchains in those files and the versions in the Cargo.tomls.

cc #13556

changelog: none

@rustbot
Copy link
Collaborator

rustbot commented Nov 15, 2024

r? @blyxyas

rustbot has assigned @blyxyas.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties label Nov 15, 2024
Copy link
Member

@blyxyas blyxyas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Being that the first commit has a single file change, I think we can squash these two commits.

Copy link
Contributor

@BD103 BD103 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for working on this! :D

Comment on lines +3 to +13
<!-- begin autogenerated nightly -->
```
nightly-2024-11-14
```
<!-- end autogenerated nightly -->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Nit) This could be moved to be under the "Usage" section, where it is referred to. (As long as the generation script can handle that!)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I could, I put it here to put it as early as possible in the README.md, so that scrolling isn't necessary to get to the version. I can change this.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved it.

@flip1995 flip1995 force-pushed the prepare-clippy-utils-publish branch from 34220a7 to aada4c3 Compare November 17, 2024 17:13
- Add metadata to clippy_utils/Cargo.toml file
- Add clippy_utils README.md file
@flip1995 flip1995 force-pushed the prepare-clippy-utils-publish branch from aada4c3 to 74b95f2 Compare November 17, 2024 17:16
@flip1995
Copy link
Member Author

@blyxyas Rebased on top of master, and squashed the commits.

Copy link
Member

@blyxyas blyxyas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks! ❤️

@blyxyas blyxyas added this pull request to the merge queue Nov 17, 2024
Merged via the queue into rust-lang:master with commit 0712689 Nov 17, 2024
9 checks passed
@flip1995 flip1995 deleted the prepare-clippy-utils-publish branch November 18, 2024 08:59
github-merge-queue bot pushed a commit that referenced this pull request Nov 19, 2024
Based on #13693

Adds 2 subcommands to `cargo dev`:

- `cargo dev sync update_nightly`: Which updates the nightly versions in
`rust-toolchain` and `clippy_utils/README.md`
- `cargo dev release bump_version`: Bumps the version in all relevant
`Cargo.toml` files

Those are pulled out of
#12759, which I'll rebase
on this.

Next step is to update the documentation, which I'll partly pull out of
#12762

r? @blyxyas (as you reviewed the first PR in the chain and were assigned
to the second one)

cc #13556

changelog: none
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants