@contractspec/action.validation 2.9.0 → 3.1.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.
Files changed (3) hide show
  1. package/AGENTS.md +17 -24
  2. package/CHANGELOG.md +12 -0
  3. 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
- This is the ContractSpec GitHub Action for CI/CD integration.
5
+ ContractSpec GitHub Action for CI/CD integration. Wraps the `contractspec ci` CLI command as a composite action.
6
6
 
7
- ## Structure
7
+ ## Quick Context
8
8
 
9
- - `action.yml` - GitHub Action definition (composite action)
10
- - `README.md` - Usage documentation
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
- ## How It Works
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
- ## Modifying the Action
22
+ ## Key Files
24
23
 
25
- When making changes:
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
- 1. Update `action.yml` for input/output changes
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
- ```yaml
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
- ## Inputs/Outputs
32
+ ## Guardrails
36
33
 
37
- All inputs and outputs are defined in `action.yml`. The action wraps the `contractspec ci` CLI command.
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
- ## Publishing
38
+ ## Local Commands
40
39
 
41
- The action is published as part of the monorepo. Users reference it as:
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
@@ -1,5 +1,17 @@
1
1
  # @contractspec/action.validation
2
2
 
3
+ ## 3.1.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 28987eb: chore: upgrade dependencies
8
+
9
+ ## 3.0.0
10
+
11
+ ### Major Changes
12
+
13
+ - b781ce6: feat: improve ai readiness
14
+
3
15
  ## 2.9.0
4
16
 
5
17
  ### Minor Changes
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@contractspec/action.validation",
3
- "version": "2.9.0",
3
+ "version": "3.1.0",
4
4
  "description": "GitHub Action for running ContractSpec CI checks",
5
5
  "repository": {
6
6
  "type": "git",