Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
33 changes: 33 additions & 0 deletions .github/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name-template: 'v$RESOLVED_VERSION'
tag-template: 'v$RESOLVED_VERSION'
categories:
- title: '🚀 Features'
labels:
- 'feature'
- 'enhancement'
- title: '🐛 Bug Fixes'
labels:
- 'fix'
- 'bugfix'
- 'bug'
- title: '🧰 Maintenance'
labels:
- 'chore'
- 'dependencies'
version-resolver:
major:
labels:
- 'major'
minor:
labels:
- 'minor'
patch:
labels:
- 'patch'
default: patch
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
change-title-escapes: '\<*_&'
template: |
## Changes

$CHANGES
18 changes: 18 additions & 0 deletions .github/workflows/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Release Drafter

on:
push:
branches:
- main
workflow_dispatch:

permissions:
contents: write

jobs:
update_release_draft:
runs-on: ubuntu-latest
steps:
- uses: release-drafter/release-drafter@v7
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
17 changes: 17 additions & 0 deletions .github/workflows/z-major-tagging.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: major-tagging

on:
push:
tags:
- v**

permissions:
contents: write

jobs:
tag:
name: Move major tag
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- uses: phwt/major-tagging-action@v1
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,20 @@ jobs:
| `diff_file` | Path to the diff output file (if generated) |
| `exit_code` | Exit code from the StructKit command |

## Releases

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`
- **Major Version Tags**: When a release like `v1.2.3` is published, the major tag `v1` is automatically created/moved to point to it
- **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

The major version tag (`v1`) is maintained automatically, so users can always reference the latest stable v1.x.x release using `@v1`.


## Advanced Examples

### Use Specific StructKit Version
Expand Down Expand Up @@ -329,3 +343,4 @@ MIT License - see [LICENSE](LICENSE) file for details.
For issues and questions:
- [Open an issue](https://github.com/httpdss/structkit-action/issues)
- [StructKit Documentation](https://github.com/httpdss/structkit)

Loading