Skip to content

tools: add HTML previews for PR containing doc changes #47196

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

tools: add HTML previews for PR containing doc changes #47196

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a5dc747
tools: add HTML previews for PR containing doc changes
aduh95 Mar 21, 2023
45adab0
push to a separate repo, clear on PR close
aduh95 Mar 22, 2023
29b4991
Make it nodejs only
aduh95 Mar 25, 2023
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
29 changes: 29 additions & 0 deletions .github/workflows/doc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,32 @@ jobs:
path: out/doc
- name: Test
run: NODE=$(command -v node) make test-doc-ci TEST_CI_ARGS="-p actions --measure-flakiness 9"
build-preview:
if: github.event.pull_request
needs: build-docs
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Check out the gh-pages branch
uses: actions/checkout@v3
with:
# We want to persist credentials so we can push to gh-pages
persist-credentials: true
ref: gh-pages
- name: Erase previous version (if it exists)
run: rm -rf "${{ github.event.pull_request.number }}"
- name: Download tarball from build job
uses: actions/download-artifact@v3
with:
name: docs
path: ${{ github.event.pull_request.number }}
- name: Commit the doc preview to gh-pages
run: |
git config user.email "[email protected]"
git config user.name "Node.js GitHub Bot"
git add "${{ github.event.pull_request.number }}"
git commit \
-m "Add/Update preview for ${{ github.event.pull_request.html_url }}" \
-m "The preview will be available at https://${{ github.repository_owner }}.github.io/${{ github.event.pull_request.base.repo.name }}/${{ github.event.pull_request.number }}/api/"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd also prefer to use either a different repository or a different URL at least that more clearly indicates that these are not official docs, but rather (untrusted) previews.

git push origin HEAD:gh-pages