@weareikko/code-review 0.8.3 → 0.8.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -110,7 +110,7 @@ jobs:
110
110
  steps:
111
111
  # Checkout (full history) is bundled — no separate checkout step needed.
112
112
  # Opt out with `checkout: false` if your job already checked out the code.
113
- - uses: weareikko/code-review@0.8.2 # pin to a release tag
113
+ - uses: weareikko/code-review@0.8 # moving minor tag — auto patch updates (see Pinning below)
114
114
  with:
115
115
  model: anthropic/claude-sonnet-4-5
116
116
  api-key: ${{ secrets.ANTHROPIC_API_KEY }}
@@ -122,6 +122,13 @@ Inputs: `model` (required), `api-key`, `github-token` (default `${{ github.token
122
122
 
123
123
  Because the composite action references your secrets directly (`${{ secrets.ANTHROPIC_API_KEY }}`), it works from **any** repository, including consumers in a different organization from this one.
124
124
 
125
+ > **Pinning the ref.** Two moving tags are maintained, each re-pointed to the latest release it covers:
126
+ >
127
+ > - `@0.8` — **minor series**: newest `0.8.x`, patches only. Because a `0.x` minor bump marks a breaking change, this is the non-breaking channel and the recommended pin while the project is pre-1.0.
128
+ > - `@0` — **major series**: newest stable release. **Caveat:** in 0.x a minor bump _is_ a breaking change, so `@0` may advance across breaking releases (`0.8 → 0.9`); it becomes a true semver compatibility boundary only once `1.0` ships.
129
+ >
130
+ > For a frozen build, pin an exact patch (`@0.8.3`) or a commit SHA (immutable; strongest supply-chain posture); to track the tip, use `@main`. GitHub `uses:` refs do not support wildcards, so `@0.8.x` is not valid — use a moving tag instead.
131
+
125
132
  ### Reusable workflow (same org/enterprise)
126
133
 
127
134
  The bundled reusable workflow lets a caller enable reviews with no `steps:` of its own — it checks out the code, installs the CLI, and runs the review for you:
@@ -137,7 +144,7 @@ permissions:
137
144
 
138
145
  jobs:
139
146
  review:
140
- uses: weareikko/code-review/.github/workflows/code-review.yml@0.8.2 # pin to a release tag
147
+ uses: weareikko/code-review/.github/workflows/code-review.yml@0.8 # moving minor tag — auto patch updates
141
148
  secrets: inherit
142
149
  ```
143
150