Skip to content
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

dev: build HTML from src/oas.md #4254

Merged
merged 6 commits into from
Jan 15, 2025
Merged

dev: build HTML from src/oas.md #4254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3d83a95
Build HTML from src/oas.md
ralfhandl Dec 16, 2024
a3425f2
builld into deploy-preview
ralfhandl Dec 19, 2024
0b187b6
Temp files in deploy-preview
ralfhandl Dec 23, 2024
b9c7b91
Tempfile in folder next to js folder
ralfhandl Dec 23, 2024
126d46a
Merge remote-tracking branch 'upstream/dev' into dev-build-src
ralfhandl Jan 8, 2025
8a2bb17
Preview and lint spec changes
ralfhandl Jan 15, 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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ target
atlassian-ide-plugin.xml
node_modules/
deploy/
deploy-preview/
coverage/
history
Gemfile.lock
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,21 @@ This might apply to, for example, Markdown files, automation, and scripts.
For all pull requests, if they should not be merged yet for any reason (they depend on something else, you would like feedback from a specific reviewer), mark them as draft and they will not be merged while in that state.
Draft pull requests can still be reviewed while in draft state.

### Preview specification HTML locally

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`
5. Open output file `deploy-preview/oas.html` with a browser

Before creating a pull request or marking a draft pull request as ready for review, please

6. Execute `npm run validate-markdown` and fix any reported problems in `src/oas.md`

## Reviewers

> [!NOTE]
Expand Down
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
"license": "Apache-2.0",
"scripts": {
"build": "bash ./scripts/md2html/build.sh",
"build-src": "bash ./scripts/md2html/build-src.sh",
"test": "c8 --100 vitest --watch=false && bash scripts/schema-test-coverage.sh",
"validate-markdown": "npx mdv src/oas.md && npx markdownlint-cli src/oas.md"
},
Expand Down
26 changes: 26 additions & 0 deletions scripts/md2html/build-src.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
#!/usr/bin/env bash

# Author: @ralfhandl

# run this script from the root of the repo

mkdir -p deploy-preview/temp
mkdir -p deploy-preview/js

cp -p node_modules/respec/builds/respec-w3c.* deploy-preview/js/

cd scripts/md2html

filename=src/oas.md
tempfile=../../deploy-preview/temp/oas.html
echo "=== ${filename} ==="

node md2html.js --maintainers ../../EDITORS.md ../../${filename} > $tempfile
npx respec --use-local --src $tempfile --out ../../deploy-preview/oas.html
rm $tempfile

echo Built deploy-preview/oas.html
echo

rm -r ../../deploy-preview/js
rmdir ../../deploy-preview/temp
Loading