Skip to content

Commit 08268e4

Browse files
handrewscodex
andcommitted
Document shared infrastructure usage
Co-authored-by: Codex <codex@openai.com>
1 parent 8833530 commit 08268e4

4 files changed

Lines changed: 6808 additions & 8 deletions

File tree

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,23 @@ When you engage with this project, please:
2525
We actively close interactions that don't meet these expectations, so please don't be offended as we protect the time and energy of our volunteers.
2626
If you do think that something was closed in error, you are welcome to reach out to us to follow up.
2727

28+
## Shared infrastructure
29+
30+
This repository uses the shared OpenAPI Initiative infrastructure package
31+
[`@oai/build-infra`](https://github.com/OAI/build-infra) for Markdown
32+
validation, HTML builds, schema publication, schema tests, and release helper
33+
commands. The npm scripts in this repository are intentionally thin wrappers
34+
around that package.
35+
36+
The shared infrastructure docs explain how the tooling works and how to maintain
37+
it:
38+
39+
- [build-infra README](https://github.com/OAI/build-infra/blob/main/README.md)
40+
- [build-infra CONTRIBUTING](https://github.com/OAI/build-infra/blob/main/CONTRIBUTING.md)
41+
42+
Most contributors only need the commands shown below. Maintainers changing the
43+
tooling itself should read the build-infra docs first.
44+
2845

2946
### Active branches
3047

@@ -233,6 +250,11 @@ The steps for creating a `vX.Y.Z-rel` branch are:
233250

234251
The HTML renderings of the specification versions are generated from the `versions` directory on `main` by manually triggering the [`respec` workflow](https://github.com/OAI/OpenAPI-Specification/blob/main/.github/workflows/respec.yaml), which generates a pull request for publishing the HTML renderings to the [spec site](https://spec.openapis.org).
235252

253+
The release commands are implemented in
254+
[`OAI/build-infra`](https://github.com/OAI/build-infra). If a command behaves
255+
unexpectedly, check this repository's `spec.config.json` first, then see the
256+
[build-infra release documentation](https://github.com/OAI/build-infra/blob/main/README.md#release-process-summary).
257+
236258
#### Start Next Patch Version
237259

238260
Once the released specification version is [synced](#branch-sync-automation) back to the `vX.Y-dev` branch, the next patch version X.Y.(Z+1) can be started:

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,13 @@ Looking to see how you can create your own OpenAPI definition, present it, or ot
3333
The current process for developing the OpenAPI Specification is described in
3434
the [Contributing Guidelines](CONTRIBUTING.md).
3535

36+
Build, test, schema publication, and release command infrastructure is shared
37+
with other OpenAPI Initiative specification repositories through
38+
[OAI/build-infra](https://github.com/OAI/build-infra). See that repository's
39+
[README](https://github.com/OAI/build-infra/blob/main/README.md) and
40+
[CONTRIBUTING guide](https://github.com/OAI/build-infra/blob/main/CONTRIBUTING.md)
41+
for details on the shared tooling.
42+
3643
Developing the next version of the OpenAPI Specification is guided by the [Technical Steering Committee (TSC)](MAINTAINERS.md). This group of committers bring their API expertise, incorporate feedback from the community, and expand the group of committers as appropriate. All development activity on the future specification will be performed as features and merged into this branch. Upon release of the future specification, this branch will be merged to `main`.
3744

3845
The TSC holds weekly web conferences to review open pull requests and discuss open issues related to the evolving OpenAPI Specification. Participation in weekly calls and scheduled working sessions is open to the community. You can view the entire OpenAPI [technical meeting calendar](https://calendar.google.com/calendar/u/0/embed?src=c_fue82vsncog6ahhjvuokjo8qsk@group.calendar.google.com) online.
@@ -51,4 +58,3 @@ Not all feedback can be accommodated, and there may be solid arguments for or ag
5158

5259
See: [License (Apache-2.0)](https://github.com/OAI/OpenAPI-Specification/blob/main/LICENSE)
5360

54-

0 commit comments

Comments
 (0)