Skip to content

Commit

Permalink
add publishing instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
busticated committed Oct 15, 2023
1 parent c2d3b0b commit fa508af
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,22 @@ Run `cargo xtask help` to see any other docs-related commands that are available
</p>
</details>

<details id="develop-publish-crate">
<summary><b>How to publish crates</b></summary>
<p>

To publish a crate to the [crates.io](https://crates.io) registry, follow these steps:

1. Checkout the `main` branch: `git checkout main`
2. Run `cargo xtask crate:release` and follow the prompts
3. Verify all checks pass: `cargo xtask ci`
4. Push to remote: `git push origin main --follow-tags`

Each crate you select for publishing will be assigned its new version and all changes will be committed and tagged in `git`. The assigned tag will be formatted like `name@version` (e.g. `detect-newline-style@1.0.0`). After pushing to the remote, CI will execute the publishing steps and if all goes well, your crate will be available on [crates.io](https://crates.io).

</p>
</details>

<details id="develop-todo">
<summary><b>How to view and add TODO source code comments</b></summary>
<p>
Expand Down

0 comments on commit fa508af

Please sign in to comment.