diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 76660343ca2..c9d2b312366 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -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 diff --git a/doc/api/assert.md b/doc/api/assert.md index d40300cc3fd..b01f135c187 100644 --- a/doc/api/assert.md +++ b/doc/api/assert.md @@ -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.