shopify-upgrade-guard 0.2.3 → 0.2.4
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 +16 -13
- package/action.yml +1 -1
- package/dist/index.js +1 -1
- package/package.json +4 -4
- package/src/output.js +1 -1
- package/src/version.js +1 -1
package/README.md
CHANGED
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
[](https://www.npmjs.com/package/shopify-upgrade-guard)
|
|
6
6
|
[](https://www.npmjs.com/package/shopify-upgrade-guard)
|
|
7
|
-
[](https://github.com/RexCode-Digital/shopify-upgrade-guard/actions/workflows/ci.yml)
|
|
8
|
+
[](https://github.com/RexCode-Digital/shopify-upgrade-guard/actions/workflows/codeql.yml)
|
|
9
|
+
[](LICENSE)
|
|
10
10
|
|
|
11
11
|
Shopify Upgrade Guard is an offline, evidence-backed CLI and GitHub Action for Shopify developers. It scans a repository for documented upgrade and deprecation risks, evaluates them against a target Shopify API version, and gives you migration guidance backed by official Shopify sources.
|
|
12
12
|
|
|
@@ -14,7 +14,9 @@ Shopify Upgrade Guard is an offline, evidence-backed CLI and GitHub Action for S
|
|
|
14
14
|
|
|
15
15
|
> Unofficial open-source developer tooling. Not affiliated with, endorsed by, or certified by Shopify.
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
Maintained by RexCode Digital Ltd.
|
|
18
|
+
|
|
19
|
+
Part of the **RexCode Shopify developer tools** suite. Requires Node.js 20 or later for the CLI. [Releases](https://github.com/RexCode-Digital/shopify-upgrade-guard/releases) · [npm](https://www.npmjs.com/package/shopify-upgrade-guard) · [Marketplace](https://github.com/marketplace/actions/shopify-upgrade-guard)
|
|
18
20
|
|
|
19
21
|
## Quick start
|
|
20
22
|
|
|
@@ -65,14 +67,14 @@ jobs:
|
|
|
65
67
|
fetch-depth: 0
|
|
66
68
|
persist-credentials: false
|
|
67
69
|
|
|
68
|
-
- uses:
|
|
70
|
+
- uses: RexCode-Digital/shopify-upgrade-guard@4e288cbc58a3186a7304785615f7255c0e3d0155 # v0.2.3
|
|
69
71
|
with:
|
|
70
72
|
target: 2026-10
|
|
71
73
|
fail-on: warning
|
|
72
74
|
fail-on-new: 'true'
|
|
73
75
|
```
|
|
74
76
|
|
|
75
|
-
|
|
77
|
+
Use the immutable patch release tag or a reviewed full commit SHA. Existing minor aliases are retained for compatibility and are not moved by future releases.
|
|
76
78
|
|
|
77
79
|
### Action inputs
|
|
78
80
|
|
|
@@ -82,6 +84,7 @@ For convenience, workflows may use the movable minor release alias `efegokdemir/
|
|
|
82
84
|
| `fail-on` | Policy threshold: `never`, `error`, `warning`, or `info` |
|
|
83
85
|
| `fail-on-new` | Apply the failure threshold only to findings introduced by the PR |
|
|
84
86
|
| `path` | Repository path to scan |
|
|
87
|
+
| `base-ref` | Explicit Git base for comparison; defaults to origin/PR-base for new-only pull-request checks |
|
|
85
88
|
|
|
86
89
|
### Action outputs
|
|
87
90
|
|
|
@@ -186,9 +189,9 @@ See [SECURITY.md](SECURITY.md) and the [threat model](docs/threat-model.md).
|
|
|
186
189
|
|
|
187
190
|
Building or maintaining Shopify apps?
|
|
188
191
|
|
|
189
|
-
- **[ChangeGuard](https://github.com/
|
|
190
|
-
- **[Shopify Scope Guard](https://github.com/
|
|
191
|
-
- **[Shopify App Review Guard](https://github.com/
|
|
192
|
+
- **[ChangeGuard](https://github.com/RexCode-Digital/shopify-app-changeguard)** — Review meaningful `shopify.app*.toml` configuration changes before they reach production.
|
|
193
|
+
- **[Shopify Scope Guard](https://github.com/RexCode-Digital/shopify-scope-guard)** — Audit whether declared Shopify permissions are supported by offline code evidence.
|
|
194
|
+
- **[Shopify App Review Guard](https://github.com/RexCode-Digital/shopify-app-review-guard)** — Run deterministic preflight checks for Shopify App Store and production readiness.
|
|
192
195
|
|
|
193
196
|
GitHub Marketplace: [Shopify Upgrade Guard](https://github.com/marketplace/actions/shopify-upgrade-guard)
|
|
194
197
|
|
|
@@ -206,7 +209,7 @@ A Shopify-specific rule should include:
|
|
|
206
209
|
4. migration guidance
|
|
207
210
|
5. positive and false-positive tests
|
|
208
211
|
|
|
209
|
-
Start with [the contribution guide](CONTRIBUTING.md) or browse the [open issues](https://github.com/
|
|
212
|
+
Start with [the contribution guide](CONTRIBUTING.md) or browse the [open issues](https://github.com/RexCode-Digital/shopify-upgrade-guard/issues).
|
|
210
213
|
|
|
211
214
|
## Roadmap
|
|
212
215
|
|
|
@@ -220,12 +223,12 @@ MIT — see [LICENSE](LICENSE).
|
|
|
220
223
|
|
|
221
224
|
## Immutable SHA usage
|
|
222
225
|
|
|
223
|
-
|
|
226
|
+
The Action example pins the reviewed v0.2.3 release commit. Verify the release reference with:
|
|
224
227
|
|
|
225
228
|
```bash
|
|
226
|
-
gh api repos/
|
|
229
|
+
gh api repos/RexCode-Digital/shopify-upgrade-guard/git/ref/tags/v0.2.3 --jq .object.sha
|
|
227
230
|
```
|
|
228
231
|
|
|
229
|
-
Published patch tags
|
|
232
|
+
Published patch tags and existing minor aliases are retained. Future releases do not move minor aliases; use an immutable patch tag or a reviewed full commit SHA.
|
|
230
233
|
|
|
231
234
|
The Action `base-ref` input selects an explicit Git comparison base. With `fail-on-new: true`, pull-request events default to `origin/<base branch>`; other events must supply `base-ref`. Ordinary scans do not infer a comparison from GitHub environment variables.
|