@contractspec/action.validation 3.0.0 → 3.2.0
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/AGENTS.md +17 -24
- package/CHANGELOG.md +12 -0
- package/package.json +1 -1
package/AGENTS.md
CHANGED
|
@@ -2,15 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
Scope: `packages/apps/action-validation/*`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
ContractSpec GitHub Action for CI/CD integration. Wraps the `contractspec ci` CLI command as a composite action.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Quick Context
|
|
8
8
|
|
|
9
|
-
-
|
|
10
|
-
-
|
|
11
|
-
- `package.json` - Package metadata (private, not published to npm)
|
|
9
|
+
- **Layer**: app (GitHub Action)
|
|
10
|
+
- **Consumers**: external CI/CD pipelines via `lssm/contractspec-action@v1`
|
|
12
11
|
|
|
13
|
-
##
|
|
12
|
+
## Architecture
|
|
14
13
|
|
|
15
14
|
This is a **composite action** that:
|
|
16
15
|
|
|
@@ -20,28 +19,22 @@ This is a **composite action** that:
|
|
|
20
19
|
4. Uploads SARIF to GitHub Code Scanning (optional)
|
|
21
20
|
5. Uploads results as artifacts
|
|
22
21
|
|
|
23
|
-
##
|
|
22
|
+
## Key Files
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
- `action.yml` — GitHub Action definition (composite action)
|
|
25
|
+
- `README.md` — Usage documentation
|
|
26
|
+
- `package.json` — Package metadata (private, not published to npm)
|
|
26
27
|
|
|
27
|
-
|
|
28
|
-
2. Update `README.md` for documentation
|
|
29
|
-
3. Test locally using `act` or by referencing the local action:
|
|
28
|
+
## Public Exports
|
|
30
29
|
|
|
31
|
-
|
|
32
|
-
- uses: ./packages/apps/action-validation
|
|
33
|
-
```
|
|
30
|
+
None — this is a GitHub Action, not an npm package. Inputs/outputs are defined in `action.yml`.
|
|
34
31
|
|
|
35
|
-
##
|
|
32
|
+
## Guardrails
|
|
36
33
|
|
|
37
|
-
All
|
|
34
|
+
- All input/output changes must be reflected in both `action.yml` and `README.md`.
|
|
35
|
+
- The action is versioned with tags on the repository — breaking input changes require a major version bump.
|
|
36
|
+
- Test locally using `act` or by referencing the local action: `uses: ./packages/apps/action-validation`.
|
|
38
37
|
|
|
39
|
-
##
|
|
38
|
+
## Local Commands
|
|
40
39
|
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
```yaml
|
|
44
|
-
- uses: lssm/contractspec-action@v1
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
The action is versioned with tags on the repository.
|
|
40
|
+
- No build step — this is a composite action defined in `action.yml`.
|
package/CHANGELOG.md
CHANGED