Skip to content

docs: pin README usage to @v0 and pair with structkit-action #2

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
httpdss merged 1 commit into from
Oct 10, 2026
Merged

docs: pin README usage to @v0 and pair with structkit-action #2

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
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- uses: httpdss/structkit-setup@v1
- uses: httpdss/structkit-setup@v0
- run: structkit --help
- run: structkit generate --help
```
Expand All @@ -29,16 +29,16 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- uses: httpdss/structkit-setup@v1
- uses: httpdss/structkit-action@v1
- uses: httpdss/structkit-setup@v0
- uses: httpdss/structkit-action@v0
with:
command: validate
```

### Pin a version

```yaml
- uses: httpdss/structkit-setup@v1
- uses: httpdss/structkit-setup@v0
with:
structkit-version: "3.3.0"
python-version: "3.12"
Expand All @@ -47,7 +47,7 @@ jobs:
### Install from git

```yaml
- uses: httpdss/structkit-setup@v1
- uses: httpdss/structkit-setup@v0
with:
structkit-version: "https://github.com/httpdss/structkit.git@main"
```
Expand All @@ -70,7 +70,7 @@ jobs:
| `cache-hit` | `true` when the tool cache was restored |

```yaml
- uses: httpdss/structkit-setup@v1
- uses: httpdss/structkit-setup@v0
id: structkit
- run: echo "Installed ${{ steps.structkit.outputs.version }} (cache-hit=${{ steps.structkit.outputs.cache-hit }})"
```
Expand All @@ -94,10 +94,10 @@ If `structkit` is already on `PATH` at the requested version, the install (and c
This repository uses automated release management with semantic versioning:

- **Release Drafting**: Releases are automatically drafted when PRs are merged to main
- **First Release**: Will be tagged as `v1.0.0`
- **Published tags**: `v0.0.1` and the floating major tag `v0` (moved by the major-tagging workflow)
- **Pinning Recommendations**:
- Use `@v1` to automatically get minor and patch updates (recommended for most users)
- Use `@v1.0.0` to pin to a specific version
- Use `@v0` to automatically get minor and patch updates (recommended for most users)
- Use `@v0.0.1` to pin to a specific version

## License

Expand Down
Loading