Skip to content

Commit 4dde713

Browse files
committed
readME update for github pages
1 parent 74b1ab7 commit 4dde713

1 file changed

Lines changed: 13 additions & 1 deletion

File tree

docs/GITHUB_ACTIONS_README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,19 @@ This repository uses GitHub Actions to automatically run API tests using Maven a
2020

2121
## Test Reports
2222

23-
After each run, Allure results are available as downloadable workflow artifacts in the GitHub Actions run summary.
23+
After each run:
24+
25+
- **Artifacts:** Allure results (`allure-results`) and the generated HTML report (`allure-report`) are available as downloadable workflow artifacts in the GitHub Actions run summary.
26+
- **Online Viewing:** The workflow automatically deploys the latest Allure HTML report to GitHub Pages (`gh-pages` branch). Only the most recent report is available online, and it is overwritten with each run.
27+
28+
### How to View the Latest Allure Report Online
29+
30+
1. Go to your repository’s **Settings > Pages**.
31+
2. Set the source branch to `gh-pages` and folder to `/` (root).
32+
3. Save the settings. GitHub will provide a public URL (e.g., `https://<your-username>.github.io/api-testing-java/`).
33+
4. Open the URL in your browser to view the latest Allure report.
34+
35+
> **Note:** The report is public if your repository is public. Review your test results for sensitive information before publishing.
2436
2537
- To change the schedule, edit the `cron` value in `.github/workflows/api-tests.yml`.
2638
- To add more branches or steps, update the workflow file as needed.

0 commit comments

Comments
 (0)