testland/living-documentation-publisher
Converts passing Cucumber JSON output into stakeholder-facing living documentation: generates HTML reports via multiple-cucumber-html-reporter (Node) or Serenity BDD aggregate (JVM), applies Gherkin tags to drive report sections, and publishes to GitHub/GitLab Pages in CI. Use when BDD scenarios are in use and the team needs an always-current, non-test-engineer-readable document showing which acceptance criteria pass.
73
92%
Does it follow best practices?
Run evals on this skill
Adds up to 20 points to the overall score
View guide
Passed
No findings from the security scan
ci-publish.mdreferences/
Publish living documentation to Pages (CI)
Publishes the generated HTML report to GitHub or GitLab Pages so stakeholders get a URL, not a zip file. Referenced from living-documentation-publisher Step 6.
GitHub Actions
name: Living Documentation
on:
push:
branches: [main]
jobs:
publish-docs:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 20
- name: Run tests and generate report
run: |
npm ci
npm test
node scripts/generate-report.js
- name: Publish to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/living-documentationFor Serenity (JVM), replace the generate step and point publish_dir at
target/site/serenity.
GitLab Pages
pages:
stage: deploy
script:
- npm ci
- npm test
- node scripts/generate-report.js
- mkdir -p public
- cp -r docs/living-documentation/* public/
artifacts:
paths:
- public
only:
- mainSee github-actions-test-jobs (in the qa-ci-integration plugin) for general
CI test-job conventions.