diff --git a/.github/workflows/playwright.yml b/.github/workflows/playwright.yml index 1ab7830a..e6d09fe0 100644 --- a/.github/workflows/playwright.yml +++ b/.github/workflows/playwright.yml @@ -1,4 +1,4 @@ -name: Testing for visual regression on old theme +name: Running Playwright test on UI # Run the workflow when code is pushed or when a pull request is created on: @@ -25,19 +25,16 @@ jobs: - name: Install dependencies and playwright browsers run: cd tests && npm ci && npx playwright install --with-deps - name: Run Playwright tests - id: test-visual + id: test-ui run: | make tests | tee output.log - if grep -q -e "Error: A snapshot doesn't exist at" -e "Screenshot comparison failed" output.log; then - echo "Playwright tests failed due to a snapshot issue." - exit 1 - elif grep -q "failed" output.log; then - echo "Playwright tests failed due to a non-snapshot issue." + if grep -q "failed" output.log; then + echo "Playwright tests failed. Please view the Playwright report to see full error." exit 1 fi - uses: actions/upload-artifact@v4 id: artifact-upload - if: ${{ !cancelled() && failure() && steps.test-visual.conclusion == 'failure' }} + if: ${{ !cancelled() && failure() && steps.test-ui.conclusion == 'failure' }} with: name: playwright-report path: tests/playwright-report/ @@ -47,10 +44,9 @@ jobs: if: ${{ failure() }} with: script: | - const body = `### Playwright visual snapshot differences were detected. + const body = `### Playwright differences were detected. - View the [Playwright report](${{ steps.artifact-upload.outputs.artifact-url }}) - **To approve the snapshot changes and update the snapshots, please comment:** /approve-snapshots`; + View the [Playwright report](${{ steps.artifact-upload.outputs.artifact-url }})`; await github.rest.issues.createComment({ issue_number: context.issue.number, diff --git a/.github/workflows/update-screenshot.yml b/.github/workflows/update-screenshot.yml deleted file mode 100644 index 30f7f39f..00000000 --- a/.github/workflows/update-screenshot.yml +++ /dev/null @@ -1,58 +0,0 @@ -name: Update screenshot on comment -on: - issue_comment: - types: [created] -jobs: - update-screenshots: - name: Update Screenshot - if: github.event.issue.pull_request && contains(github.event.comment.body, '/approve-snapshots') - runs-on: ubuntu-latest - permissions: - contents: write - pull-requests: write - steps: - - uses: xt0rted/pull-request-comment-branch@v3 - id: comment-branch - - uses: actions/checkout@v4 - if: success() - with: - ref: ${{ steps.comment-branch.outputs.head_ref }} - - name: Comment on PR with Playwright updates - uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1 - with: - script: | - const body = `### Updating snapshots. Click [here](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}) to see the status.`; - - await github.rest.issues.createComment({ - issue_number: context.issue.number, - owner: context.repo.owner, - repo: context.repo.repo, - body: body, - }); - - name: Setup Hugo - uses: peaceiris/actions-hugo@75d2e84710de30f6ff7268e08f310b60ef14033f # v3.0.0 - with: - hugo-version: "0.147.8" - extended: true - - name: Install dependencies and Playwright browsers - run: cd tests && npm ci && npx playwright install --with-deps - - name: Run Playwright update snapshots - id: test-visual - run: make tests-update-screenshots - - uses: actions/upload-artifact@v4 - id: artifact-upload - with: - name: screenshots - path: tests/src/__screenshots__ - - name: Comment on PR with success - uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1 - with: - script: | - const body = `### Please download the artifacts [here](${{ steps.artifact-upload.outputs.artifact-url }}) and commit your updated screenshots.`; - - await github.rest.issues.createComment({ - issue_number: context.issue.number, - owner: context.repo.owner, - repo: context.repo.repo, - body: body, - }); \ No newline at end of file diff --git a/Makefile b/Makefile index 700ba6f1..827d83e7 100644 --- a/Makefile +++ b/Makefile @@ -6,18 +6,18 @@ WRITE_FLAG := --write list help:: $(info Available Make targets:) @echo "" - @echo " list | help: Print these available make targets" + @echo " list | help: Print these available make targets" @echo "" @echo " biome-format: Runs the biome formatter." @echo " biome-lint: Runs the biome linter." @echo " biome-all: Runs both the lint and formatting commands." @echo " build-example-site: Builds hugo exampleSite." - @echo " (Set BIOME_ARGS to add additional arguments to biome command (ex: make biome-all BIOME_ARGS=write))" + @echo "(Set BIOME_ARGS to add additional arguments to biome command (ex: make biome-all BIOME_ARGS=write))" @echo "" @echo " setup-pre-commit: Sets up pre-commit (assuming it is installed)" @echo "" - @echo " tests: Runs playwright against the old theme." - @echo " tests-update-screenshots: Runs playwright against the old theme." + @echo " tests: Runs playwright against the new theme." + @echo " tests-update-screenshots: Runs playwright against the new theme." .PHONY: biome-format biome-lint biome-all setup-pre-commit tests build-example-site FLAG := diff --git a/exampleSite/content/test-product/tab-group/tab-group.md b/exampleSite/content/test-product/tab-group/tab-group.md index c4018136..c06b6ad1 100644 --- a/exampleSite/content/test-product/tab-group/tab-group.md +++ b/exampleSite/content/test-product/tab-group/tab-group.md @@ -6,6 +6,7 @@ weight: 200 ## tab-group +
{{}} {{%tab name="Call Outs"%}} @@ -65,6 +66,7 @@ nginx -s reload {{}} +
## Much nested tab group diff --git a/exampleSite/go.mod b/exampleSite/go.mod index 996bf7fa..15df12c0 100644 --- a/exampleSite/go.mod +++ b/exampleSite/go.mod @@ -2,6 +2,6 @@ module github.com/nginxinc/docs go 1.23 -require github.com/nginxinc/nginx-hugo-theme v0.41.27 // indirect +require github.com/nginxinc/nginx-hugo-theme v1.0.4 // indirect replace github.com/nginxinc/nginx-hugo-theme => ../ diff --git a/layouts/404.html b/layouts/404.html index 209abd72..95f5f51e 100644 --- a/layouts/404.html +++ b/layouts/404.html @@ -1,7 +1,7 @@ {{ define "main"}} -
-
+
+

HTTP 404 - Page not found

diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html index 4eabd547..eb6ef345 100644 --- a/layouts/_default/baseof.html +++ b/layouts/_default/baseof.html @@ -44,17 +44,17 @@
-