Skip to content

dev: update from main #4490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
Mar 24, 2025
Merged

dev: update from main #4490

Changes from 3 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
d14327b
Update package.json
ralfhandl Mar 18, 2025
7a4a5d5
Create adjust-release-branch.sh
ralfhandl Mar 18, 2025
9ba315d
Make executable
ralfhandl Mar 18, 2025
b1f703f
Mention in CONTRIBUTING.md
ralfhandl Mar 19, 2025
ac7946e
Hint for Windows users
ralfhandl Mar 19, 2025
d53c93c
Port from dev
ralfhandl Mar 20, 2025
b70d917
Update issue templates
ralfhandl Mar 21, 2025
9dd22cf
Merge pull request #4462 from ralfhandl/main-contributing-windows
miqui Mar 22, 2025
8a3f194
Merge pull request #4486 from OAI/ralfhandl-patch-1
miqui Mar 22, 2025
e09c356
Merge pull request #4481 from ralfhandl/main-sync-scripts-from-dev
miqui Mar 22, 2025
930f40b
Merge pull request #4452 from ralfhandl/main-package.json-description
miqui Mar 22, 2025
a4b47df
Merge pull request #4454 from ralfhandl/main-adjust-release-branch
miqui Mar 22, 2025
d49cb6f
Bump respec from 35.2.3 to 35.3.0
dependabot[bot] Mar 24, 2025
1b84b6f
Merge pull request #4491 from OAI/dependabot/npm_and_yarn/respec-35.3.0
ralfhandl Mar 24, 2025
bbafa53
Update CONTRIBUTING.md
ralfhandl Mar 24, 2025
8be81a5
@lornajane's proposal
ralfhandl Mar 24, 2025
b9c0963
Merge pull request #4494 from OAI/ralfhandl-main-contributing-note
lornajane Mar 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,15 +165,16 @@ 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

1. Install [Node.js](https://nodejs.org/)
2. Check out this repo, go to the repo root, and switch to a development branch
3. Execute `npm install` (once, repeat after merging upstream changes)
4. Execute `npm run build-src` after changing `src/oas.md` (this first executes `npm run validate-markdown`, which can also be run separately)
> [!NOTE] Use Git Bash on Windows
> This npm script calls bash scripts. Run it from [Git Bash](https://gitforwindows.org/) on Windows, or use the Windows Subsystem for Linux (WSL).
5. Open output file `deploy-preview/oas.html` with a browser and check your changes

Please make sure the markdown validates and builds using the above steps before creating a pull request or marking a draft pull request as ready for review.
Expand Down