forked fromw3c/spec-prod
- Notifications
You must be signed in to change notification settings - Fork3
GitHub Action to build ReSpec/Bikeshed specs, validate output and publish to GitHub pages or W3C
License
NotificationsYou must be signed in to change notification settings
ome/spec-prod
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
This GitHub Action lets you:
- BuildReSpec andBikeshed specs.
- Validate generated document's markup and check for broken hyperlinks.
- Publish generated spec to GitHub Pages and/or w3.org (using Echidna).
During a pull request, the action:
- figures out if you're using ReSpec (
index.html
) or Bikeshed (index.bs
) - converts the ReSpec/Bikeshed source document to regular HTML
- runs broken hyperlink checker, and validate markup using W3C nu validator
Additionally, if a commit is pushed to the "main" branch, the action deploys the built specification to the "gh-pages" branch.
# .github/workflows/pr-push.ymlname:CIon:pull_request:{}push:branches:[main]jobs:main:name:Build, Validate and Deployruns-on:ubuntu-20.04steps: -uses:actions/checkout@v2 -uses:w3c/spec-prod@v1with:GH_PAGES_BRANCH:gh-pages
Read more aboutthe available options and learn fromusage examples.
About
GitHub Action to build ReSpec/Bikeshed specs, validate output and publish to GitHub pages or W3C
Resources
License
Code of conduct
Security policy
Stars
Watchers
Forks
Packages0
No packages published
Languages
- JavaScript96.5%
- Shell3.5%