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.

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

WIP doc previews #53

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
28 changes: 28 additions & 0 deletions .github/workflows/doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,31 @@ 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
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 "github-bot@iojs.org"
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/"
git push origin HEAD:gh-pages
3 changes: 0 additions & 3 deletions doc/api/assert.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,6 @@ changes:
description: Added strict assertion mode to the assert module.
-->

In strict assertion mode, non-strict methods behave like their corresponding
strict methods. For example, [`assert.deepEqual()`][] will behave like
[`assert.deepStrictEqual()`][].

In strict assertion mode, error messages for objects display a diff. In legacy
assertion mode, error messages for objects display the objects, often truncated.
Expand Down