Separate asciidoc publish to separate workflow - #488
Merged
leandrumartin merged 22 commits intoMay 11, 2026
Merged
Conversation
…ntain permissions' Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> Signed-off-by: Leandru Martin <122942864+leandrumartin@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR separates AsciiDoc publishing (GitHub Pages deployment) from AsciiDoc building/validation, aligning documentation publishing with public releases (pushes to main) while still validating AsciiDoc builds on PRs and develop pushes.
Changes:
- Adjust
.github/workflows/asciidoc-build.ymltriggers to run on PRs tomain/develop, pushes todevelop, and viaworkflow_call; remove the GitHub Pages deploy step. - Add
.github/workflows/asciidoc-publish.ymlto run on pushes tomain, call the reusable AsciiDoc build workflow, and deploy the generated docs togh-pages.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| .github/workflows/asciidoc-build.yml | Removes deploy from the build workflow; adds pull_request + workflow_call triggers and narrows push to develop. |
| .github/workflows/asciidoc-publish.yml | New workflow that runs on main pushes and performs GitHub Pages deployment for AsciiDoc. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Leandru Martin <122942864+leandrumartin@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Leandru Martin <122942864+leandrumartin@users.noreply.github.com>
…made-live-each-time-they-are-updated' into 433-docs-should-not-be-publishedmade-live-each-time-they-are-updated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Leandru Martin <122942864+leandrumartin@users.noreply.github.com>
This is so that the existing published Javadocs there will stay there in case the Javadoc publishing step fails to upload new Javadocs. Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Leandru Martin <122942864+leandrumartin@users.noreply.github.com>
Agent-Logs-Url: https://github.com/oss-slu/Pi4Micronaut/sessions/0d00f5e4-54b0-442a-bbdb-98b3cff32e10 Co-authored-by: leandrumartin <122942864+leandrumartin@users.noreply.github.com>
…made-live-each-time-they-are-updated' into 433-docs-should-not-be-publishedmade-live-each-time-they-are-updated
This reverts commit fc484de. Co-authored-by: leandrumartin <122942864+leandrumartin@users.noreply.github.com>
…made-live-each-time-they-are-updated' into 433-docs-should-not-be-publishedmade-live-each-time-they-are-updated
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.
Comments suppressed due to low confidence (1)
.github/workflows/publish-docs.yml:18
publish-javadoccalls the reusable workflowjavadoc-gh-pages.yml, which now declareson.workflow_call.secrets.GITHUB_TOKENas required and uses${{ secrets.GITHUB_TOKEN }}. This caller job is not passing that secret, so the workflow call will fail with a missing required secret. PassGITHUB_TOKEN(or switch the called workflow to use${{ github.token }}instead of a required secret).
publish-javadoc:
needs: publish-asciidoc
uses: ./.github/workflows/javadoc-gh-pages.yml
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Leandru Martin <122942864+leandrumartin@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Leandru Martin <122942864+leandrumartin@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Leandru Martin <122942864+leandrumartin@users.noreply.github.com>
leandrumartin
deleted the
433-docs-should-not-be-publishedmade-live-each-time-they-are-updated
branch
May 11, 2026 18:27
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request Summary
Closes #433
A brief description/summary of your PR. What does it add, and why is it necessary? Does this new feature solve any problems or bugs? How was it tested — automated or manual software tests, physical hardware tests, or some other method or combination of testing techniques?
ASCIIDoc publishing has been separated from the workflow that builds them. So now:
mainordevelop, and on push todevelop. This allows the build to be validated at those times.main. This way, new documentation is published only when a new version of the library is publicly released.