Merge pull request #4490 from OAI/main

dev: update from main

Author: ralfhandl

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,18 @@
+---
+name: Bug report
+about: Create a report to help us improve the specification
+title: 'vX.Y: ...'
+labels: ''
+assignees: ''
+
+---
+
+**Describe the error in the specification**
+A clear and concise description of
+- what the error is, 
+- which specification versions are affected, 
+- what you would expect the specification to say instead,  and 
+- a link to the corresponding specification section in the "oldest" affected version.
+
+**Additional context**
+Add any other context about the problem here.

CONTRIBUTING.md

@@ -165,6 +165,9 @@ Draft pull requests can still be reviewed while in draft state.
 
 ### Preview specification HTML locally
 
+> [!NOTE]
+> `npm run build-src` calls bash scripts. Use [Git Bash](https://gitforwindows.org/) on Windows, or use the Windows Subsystem for Linux (WSL).
+
 The markdown source files are converted to HTML before publishing.
 To do this locally, please
 
@@ -199,7 +202,7 @@ The steps for creating a `vX.Y.Z-rel` branch are:
 
 1. Update `EDITORS.md` on `main`
 2. Merge `main` into `dev` and `dev` into `vX.Y-dev` via PRs
-   - Sync PRs are automatically created by workflows `sync-main-to-dev` and `sync-dev-to-vX.Y-dev`
+   - sync PRs are automatically created by workflows `sync-main-to-dev` and `sync-dev-to-vX.Y-dev`
 3. Prepare spec files in `vX.Y-dev`
    - `npm run format-markdown`
    - `npm run build-src`
@@ -211,6 +214,7 @@ The steps for creating a `vX.Y.Z-rel` branch are:
    - copy `EDITORS.md` to `versions/X.Y.Z-editors.md`
    - delete `src/schemas` 
    - delete `tests/schema`
+   - bash script `scripts/adjust-release-branch.sh` performs these steps
 5. Merge `vX.Y.Z-rel` into `main` via PR
    - this PR should only add files `versions/X.Y.Z.md` and `versions/X.Y.Z-editors.md`
 

package-lock.json

@@ -1,7 +1,7 @@
 {
-  "name": "oas-schemas",
-  "version": "2.0.0",
-  "description": "OpenAPI Specification JSON schemas",
+  "name": "oas-infra",
+  "version": "0.0.0",
+  "description": "OpenAPI Specification Automation & Infrastructure",
   "author": {
     "name": "OpenAPI Initiative TSC",
     "email": "[email protected]",
@@ -19,16 +19,11 @@
     "format-markdown": "bash ./scripts/format-markdown.sh ./src/oas.md",
     "validate-markdown": "npx mdv src/oas.md && npx markdownlint-cli src/oas.md"
   },
-  "readmeFilename": "README.md",
-  "files": [
-    "README.md",
-    "schemas/*"
-  ],
   "dependencies": {
     "cheerio": "^1.0.0-rc.5",
     "highlight.js": "^11.11.1",
     "markdown-it": "^14.1.0",
-    "respec": "35.2.3",
+    "respec": "35.3.0",
     "yargs": "^17.7.2"
   },
   "devDependencies": {

package.json

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+# Author: @ralfhandl
+
+# Run this script from the root of the repo. It is designed to be run manually in a release branch.
+
+branch=$(git branch --show-current)
+
+if [[ ! $branch =~ ^v[0-9]+\.[0-9]+\.[0-9]+-rel$ ]]; then
+  echo "This script is intended to be run from a release branch, e.g. v3.1.2-rel"
+  exit 1
+fi
+
+vVersion=$(basename "$branch" "-rel")
+version=${vVersion:1}
+echo Prepare release of $version
+
+cp EDITORS.md versions/$version-editors.md
+mv src/oas.md versions/$version.md
+rm -r src/schemas
+rm -r tests/schema