Skip to content

Commit 185136c

Browse files
committed
docs: rewrite versioning policy
1 parent c343e95 commit 185136c

2 files changed

Lines changed: 14 additions & 3 deletions

File tree

.gitlab-ci.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ image: node:20-alpine
77
- apk add --no-cache git
88
- git clone https://github.com/stainless-api/upload-openapi-spec-action.git
99
- cd upload-openapi-spec-action
10+
- npm install
1011
- node dist/index.js
1112
variables:
1213
INPUT_STAINLESS_API_KEY: $STAINLESS_API_KEY

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,16 @@ beforehand. That action needs the `contents: read` permission.
124124

125125
### Versioning policy
126126

127-
This action is in public beta, and breaking changes may be introduced in any
128-
commit. We recommend pinning your actions to a full-length commit SHA to avoid
129-
potential breaking changes.
127+
This action uses [semantic versioning](https://semver.org/), and you can pin
128+
your action to a major (`v1`), minor (`v1.0`), or patch (`v1.0.0`) version.
129+
The public API includes:
130+
131+
- The inputs to each action, and their expected format.
132+
133+
- The format of pull request comments.
134+
135+
- The name and format of the file written to `documented_spec_path`.
136+
137+
The public API does not include:
138+
139+
- The format of the `outcomes` and `base_outcomes` outputs.

0 commit comments

Comments
 (0)