Skip to content

Commit df4fd1e

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

2 files changed

Lines changed: 10 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: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,12 @@ 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 is specified by the inputs and outputs of each action. The
130+
following are not considered to be part of the public API:
131+
132+
- The exact format of pull request comments, which can change between versions.
133+
134+
- The exact format of the `outcomes` and `base_outcomes` outputs, which can
135+
change even within the same version.

0 commit comments

Comments
 (0)