The resources in this folder are used for building WHATWG standards.
deploy.sh script is used by most WHATWG standards and is meant to run either on Travis CI, or locally for preview purposes. It performs the following steps:
- Running Bikeshed, through its web API, to produce:
- If on master, the built Living Standard, as well as a commit snapshot
- Otherwise, a branch snapshot of the standard
- Running the Nu HTML checker on the build results
- Deploying the build results to the WHATWG web server
For non-local deploys, it is dependent on the following environment setup:
deploy_key.encmust contain a SSH private key, encrypted for Travis for the appropriate repository.
- The environment variable
$ENCRYPTION_LABELmust contain the encryption label produced by the Travis encryption process.
Optional environment variables:
$SERVERis the server to deploy to.
$SERVER_PUBLIC_KEYis the public key of the deploy server, in the format of
$EXTRA_FILESare extra files to copy for each build. Shell wildcards are allowed, and directory structure will be preserved. Example:
$POST_BUILD_STEPis an extra step to run after each build. Evaluated with the
$DIRvariable set to the build directory. Example:
POST_BUILD_STEP='python generate-stuff.py "$DIR"'.
.travis.yml file that uses this script would then be as follows:
language: generic env: global: - ENCRYPTION_LABEL="1337deadb33f" script: - curl --remote-name --fail https://resources.whatwg.org/build/deploy.sh && bash ./deploy.sh branches: only: - master notifications: email: on_success: never on_failure: always
Similarly, a local deploy can be performed with
curl --remote-name --fail https://resources.whatwg.org/build/deploy.sh && bash ./deploy.sh
or more typically
Whether the script is running a local vs. Travis deploy is determined by checking the
$TRAVIS environment variable.
review.sh script is also used by most WHATWG standards and is meant to be run locally to generate a new Review Draft.
It can be run with
curl --remote-name --fail https://resources.whatwg.org/build/review.sh && bash ./review.sh
or more typically
Please see https://github.com/whatwg/meta/blob/master/MAINTAINERS.md for information on creating and announcing Review Drafts.