Skip to content

Refresh crate setup guidance and release v0.3.2. #7

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.

Sign up for GitHub

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

Merged
samuel-williams-shopify merged 2 commits into from
Oct 5, 2026
Merged

Refresh crate setup guidance and release v0.3.2. #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a2127c
Align Rust crate interfaces and project guidance.
samuel-williams-shopify Oct 5, 2026
a4a9dcb
Prepare the consistency release.
samuel-williams-shopify Oct 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 18 additions & 8 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "bake-markdown"
version = "0.3.1"
version = "0.3.2"
edition = "2024"
rust-version = "1.85"
license = "MIT"
Expand Down
25 changes: 13 additions & 12 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,12 @@ Hard-wrapped paragraphs are difficult to edit consistently. This crate uses the

## Usage

Add the crate to the project's private `bake/` package and link its tasks:
Add the crate to the project's private `bake/` package and regenerate its task links:

```toml
[dependencies]
bake-markdown = "0.3"
```

```rust,ignore
use bake_markdown as _;
```sh
cargo bake --regenerate
cargo add --manifest-path bake/Cargo.toml bake-markdown
cargo bake --regenerate
```

Normalize one or more files relative to the project root:
Expand All @@ -27,12 +24,20 @@ cargo bake markdown:normalize readme.md context/guide.md

Rust callers can use `bake_markdown::normalize_document` directly.

## Releasing

Prepare a release with `cargo bake cargo:version:patch` (or `minor`, `major`, or `bump --version X.Y.Z`), then run `cargo bake cargo:release` and open a pull request. After review and merge, GitHub Actions publishes the release when the configured `crates-io` environment approves it. Follow the shared [Releasing skill](https://github.com/socketry/socketry-project-rust/blob/main/context/releasing.md) for the standard process.

## Releases

<!-- bake-readme:releases:start -->

See [releases.md](releases.md) for the full release history.

### v0.3.2

- Document the shared release process.

### v0.3.1

- Resolve development task dependencies to the current checkout.
Expand All @@ -47,10 +52,6 @@ See [releases.md](releases.md) for the full release history.

- Normalize unordered Markdown lists with hyphen markers.

### v0.2.0

- Accept Markdown paths as positional arguments to `markdown:normalize`.

<!-- bake-readme:releases:end -->

## See Also
Expand Down
4 changes: 4 additions & 0 deletions releases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Releases

## v0.3.2

- Document the shared release process.

## v0.3.1

- Resolve development task dependencies to the current checkout.
Expand Down
Loading