Skip to content

tools: add HTML previews for PR containing doc changes

Rodrigo Muino Tomonari requested to merge github/fork/aduh95/previews into main

For PR containing doc changes, the GitHub Actions workflow will push the built docs to the gh-pages branch so reviewers can have a preview of the changes without needing to pull the PR and build the docs locally. The commit that is pushed to gh-pages has a reference to the PR so the commit will appear on the GH web UI (so no need to comment I think).

You can see this PR in action on https://github.com/nodejs/node-auto-test/pull/53.

Before this can land (if we do want to land it), the following needs to happen:

  1. An empty git tree should be pushed to the gh-pages branch.
  2. GitHub Pages should be activated on this repo (this should happen automatically if the above is done by a repo admin).

Note that this PR is only adding files to the gh-pages, which will eventually get cluttered with old PR content. If you have an idea how we can manage, please chime in, otherwise we can leave the problem for our future selves to solve (reseting the gh-pages branch back to an empty git tree every few months should work well enough for our use case I think).

/cc @nodejs/tsc

Merge request reports