Add crate management section - #244
Open
sagudev wants to merge 1 commit into
Open
Conversation
Based on servo/mozjs#687 (comment) and servo/mozjs#678 (comment) Signed-off-by: Sam <16504129+sagudev@users.noreply.github.com>
jschwe
reviewed
Aug 28, 2026
| 3.1. Repository owner: servo | ||
| 3.2. Repository name: ${repo} | ||
| 3.3 Workflow filename: ${yml_file_for_publish} (Usually `publish.yml` or `release.yml`) | ||
| 3.4 Environment: Not applicable, leave empty. |
Member
There was a problem hiding this comment.
Suggested change
| 3.4 Environment: Not applicable, leave empty. | |
| 3.4 Environment: publish_crates_io (See "setting up github environment for publishing) | |
| #### Configure GitHub environment to further secure publishing | |
| We use [GitHub Environments](https://docs.github.com/en/actions/how-tos/deploy/configure-and-manage-deployments/manage-environments) to further protect the publishing. | |
| See [this guide](https://servo.zulipchat.com/user_uploads/30542/JG9Y_pWMYyU2a4P1mxFBv9Pd/servo-github-environments.pdf) for the initial setup. The steps can be varied based on the individual repositories needs. If publishing is intended to be automatic (i.e. one maintainer approval is sufficient, publish after merging a PR) then "required reviewers" can be skipped. "Protected branches only" prevents single maintainers (not admins) from creating releases from feature branches (via modified workflow files) and should always be enabled. |
jschwe
reviewed
Aug 28, 2026
jschwe
reviewed
Aug 28, 2026
| To do this we create dummy crate (0.0.0) with empty contents, just to reserve the crate name: | ||
| 1. `cargo new --lib ${create_name}` | ||
| 2. edit `Cargo.toml` and add required fields for publish: `description` and `license` | ||
| 3. `cargo publish` |
Member
There was a problem hiding this comment.
Suggested change
| 3. `cargo publish` | |
| 3. `cargo publish` | |
| # For redundancy add more (at least two) administrators as crate owners (just adding team is not enough). | |
| 4. `cargo owner --add <github handle>` (e.g. `sagudev` for `@sagudev`) |
How about just adding this here, instead of a dedicated section?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Based on servo/mozjs#687 (comment) and servo/mozjs#678 (comment)