Skip to content

Commit bbc1d4e

Browse files
authored
chore: fix outdated contributing.md (#213)
1 parent 2ae214c commit bbc1d4e

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,15 @@ Example changeset looks like this:
6767

6868
### Publishing changes
6969

70-
- On merge into `main`, if there are relevant changes, the [Release](https://github.com/fingerprintjs/fingerprint-pro-server-api-openapi/actions/workflows/release.yml) workflow can be triggered, which will consume created changeset files and create PR with bumped version and updated changelog.
71-
- When a PR is merged into `main`, the latest schema is automatically published to the [GitHub pages](https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/).
72-
- The changes are currently NOT automatically published to the [Documentation API Reference](https://dev.fingerprint.com/reference) repository. You need to publish them manually using Readme CLI or Readme dashboard. The DX team is happy to assist.
70+
On every push into `main` (merged PR):
71+
- The built schema is published to [Readme API Reference](https://dev.fingerprint.com/reference).
72+
- The built schema is published to [GitHub pages](https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/).
73+
- The built schema is published as a [raw yaml file](https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/schemas/fingerprint-server-api.yaml).
74+
75+
See the [publish.yml](.github/workflows/publish.yml) workflow for more details.
76+
77+
### GitHub releases
78+
79+
GitHub releases are used to generate Server SDKs based on a specific version of the OpenAPI schema.
80+
81+
After merging to `main`, if there are relevant changes, you can manually trigger the [Release](https://github.com/fingerprintjs/fingerprint-pro-server-api-openapi/actions/workflows/release.yml) workflow, which will consume created changeset files and create PR with bumped version and updated changelog.

0 commit comments

Comments
 (0)