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

crates-io: Add doc comment for NewCrate struct #12782

Merged
merged 2 commits into from
Oct 6, 2023

Conversation

Turbo87
Copy link
Member

@Turbo87 Turbo87 commented Oct 6, 2023

This PR adds a small doc comment to the NewCrate struct in the crates-io package, linking to https://doc.rust-lang.org/cargo/reference/registry-web-api.html#publish to give additional context.

I saw other links to https://doc.rust-lang.org in some of the doc comments, so I'm hoping this is correct vs. linking directly to the file with a relative path?

@rustbot
Copy link
Collaborator

rustbot commented Oct 6, 2023

r? @epage

(rustbot has picked a reviewer for you, use r? to override)

@rustbot rustbot added A-interacts-with-crates.io Area: interaction with registries S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 6, 2023
Copy link
Contributor

@epage epage left a comment

Choose a reason for hiding this comment

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

Just need to bump the version of the crate so it gets a release with this change.

@Turbo87
Copy link
Member Author

Turbo87 commented Oct 6, 2023

probably no need to bump it just for this change. it was mostly helpful for me while browsing the cargo codebase :)

@Turbo87
Copy link
Member Author

Turbo87 commented Oct 6, 2023

oh wait, now that I see the failing CI... did you mean to say that I should bump the version myself? how are changelogs etc. handled in that case?

@epage
Copy link
Contributor

epage commented Oct 6, 2023

Yes, to fix CI the version needs to be bumped. Its a crude check, making us release more often than we would otherwise, but we've had too many times where we forgot to release.

So far we don't have per-crate changelogs. I'm researching options for that.

@epage
Copy link
Contributor

epage commented Oct 6, 2023

@bors r+

@bors
Copy link
Contributor

bors commented Oct 6, 2023

📌 Commit 9e5dac1 has been approved by epage

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 6, 2023
@epage
Copy link
Contributor

epage commented Oct 6, 2023

Thanks!

@bors
Copy link
Contributor

bors commented Oct 6, 2023

⌛ Testing commit 9e5dac1 with merge 294fe8f...

@bors
Copy link
Contributor

bors commented Oct 6, 2023

☀️ Test successful - checks-actions
Approved by: epage
Pushing 294fe8f to master...

1 similar comment
@bors
Copy link
Contributor

bors commented Oct 6, 2023

☀️ Test successful - checks-actions
Approved by: epage
Pushing 294fe8f to master...

@bors bors merged commit 294fe8f into rust-lang:master Oct 6, 2023
@bors
Copy link
Contributor

bors commented Oct 6, 2023

👀 Test was successful, but fast-forwarding failed: 422 Changes must be made through a pull request.

@ehuss ehuss added this to the 1.75.0 milestone Oct 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-interacts-with-crates.io Area: interaction with registries S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants