Skip to content

chore: improve crates.io metadata and add cargo publish to release #29

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
mikkeldamsgaard merged 1 commit into from
Feb 26, 2026
Merged

chore: improve crates.io metadata and add cargo publish to release #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ jobs:
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
- run: cargo test --all
- name: Publish to crates.io
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

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

The cargo publish step lacks error handling for the case where the version has already been published to crates.io. If this workflow is re-run (e.g., due to a failure in a later step like Docker builds), cargo publish will fail because crate versions are immutable on crates.io. Consider adding || true or using cargo publish --dry-run first, or add a conditional check to skip publishing if the version already exists. Alternatively, add continue-on-error: true to allow the workflow to proceed even if publishing fails.

Suggested change
- name: Publish to crates.io
- name: Publish to crates.io
continue-on-error: true

Copilot uses AI. Check for mistakes.
run: cargo publish
env:
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
- uses: docker/setup-qemu-action@v3
- uses: docker/setup-buildx-action@v3
- uses: docker/login-action@v3
Expand Down
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Changed
- Improved crates.io metadata: keyword-rich description, `rust-version = "1.88"` MSRV, authors, `documentation` pointing to docs.rs, and `exclude` to reduce published crate size
- Added `#![doc = include_str!("../README.md")]` to `src/main.rs` so docs.rs renders the README as the crate landing page
- Release workflow now publishes to crates.io automatically on tag push (requires `CARGO_REGISTRY_TOKEN` secret)

### Added
- Custom MiniJinja template filters: `sha256`, `base64_encode`, `base64_decode` available in all templates (render and seed spec files)
- `sha256` filter with optional `mode` parameter (`"hex"` default, `"bytes"` for byte array output)
Expand Down
7 changes: 5 additions & 2 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,17 @@
name = "initium"
version = "1.0.4"
edition = "2021"
description = "Swiss-army toolbox for Kubernetes initContainers"
rust-version = "1.88"
authors = ["Kitstream <opensource@kitstream.io>"]
description = "Swiss-army toolbox for Kubernetes initContainers — wait-for, migrate, seed, render, fetch in a single static Rust binary"
license = "Apache-2.0"
repository = "https://github.com/KitStream/initium"
homepage = "https://github.com/KitStream/initium"
documentation = "https://github.com/KitStream/initium/blob/main/docs/usage.md"
documentation = "https://docs.rs/initium"
keywords = ["kubernetes", "initcontainer", "sidecar", "container", "devops"]
categories = ["command-line-utilities", "development-tools"]
readme = "README.md"
exclude = ["tests/", "examples/", ".github/", "charts/", "docs/", ".claude/"]

[[bin]]
name = "initium"
Expand Down
2 changes: 2 additions & 0 deletions src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#![doc = include_str!("../README.md")]

mod cmd;
mod duration;
mod logging;
Expand Down