Skip to content

Separate asciidoc publish to separate workflow - #488

Merged
leandrumartin merged 22 commits into
developfrom
433-docs-should-not-be-publishedmade-live-each-time-they-are-updated
May 11, 2026
Merged

Separate asciidoc publish to separate workflow#488
leandrumartin merged 22 commits into
developfrom
433-docs-should-not-be-publishedmade-live-each-time-they-are-updated

Conversation

@leandrumartin

Copy link
Copy Markdown
Collaborator

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:

  • The build workflow runs on PR to main or develop, and on push to develop. This allows the build to be validated at those times.
  • The new workflow to both build and publish runs only on push to main. This way, new documentation is published only when a new version of the library is publicly released.

@leandrumartin leandrumartin linked an issue May 11, 2026 that may be closed by this pull request
@leandrumartin
leandrumartin requested a review from Copilot May 11, 2026 16:56
Comment thread .github/workflows/asciidoc-publish.yml Fixed
Comment thread .github/workflows/asciidoc-publish.yml Fixed
…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>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.yml triggers to run on PRs to main/develop, pushes to develop, and via workflow_call; remove the GitHub Pages deploy step.
  • Add .github/workflows/asciidoc-publish.yml to run on pushes to main, call the reusable AsciiDoc build workflow, and deploy the generated docs to gh-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.

Comment thread .github/workflows/asciidoc-publish.yml
Comment thread .github/workflows/asciidoc-publish.yml Outdated
Comment thread .github/workflows/asciidoc-build.yml Outdated
Comment thread .github/workflows/asciidoc-publish.yml Outdated
leandrumartin and others added 4 commits May 11, 2026 12:01
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>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

Comment thread .github/workflows/publish-docs.yml
Comment thread .github/workflows/asciidoc-publish.yml Outdated
Comment thread .github/workflows/asciidoc-build.yml Outdated
leandrumartin and others added 3 commits May 11, 2026 12:15
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

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.

Comment thread .github/workflows/publish-docs.yml
Comment thread .github/workflows/publish-docs.yml
Comment thread .github/workflows/asciidoc-publish.yml Outdated
Comment thread .github/workflows/asciidoc-publish.yml Outdated
Comment thread .github/workflows/javadoc-gh-pages.yml Outdated
Comment thread .github/workflows/asciidoc-build.yml Outdated
leandrumartin and others added 3 commits May 11, 2026 12:39
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>
Copilot AI and others added 2 commits May 11, 2026 17:50
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

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-javadoc calls the reusable workflow javadoc-gh-pages.yml, which now declares on.workflow_call.secrets.GITHUB_TOKEN as 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. Pass GITHUB_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

Comment thread .github/workflows/asciidoc-publish.yml Outdated
Comment thread .github/workflows/asciidoc-publish.yml Outdated
Comment thread .github/workflows/asciidoc-publish.yml Outdated
Comment thread .github/workflows/asciidoc-build.yml Outdated
Comment thread .github/workflows/javadoc-gh-pages.yml Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

Comment thread .github/workflows/asciidoc-build.yml Outdated
Comment thread .github/workflows/asciidoc-publish.yml Outdated
Comment thread .github/workflows/javadoc-gh-pages.yml Outdated
leandrumartin and others added 3 commits May 11, 2026 13:26
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
leandrumartin merged commit ada9695 into develop May 11, 2026
6 checks passed
@leandrumartin
leandrumartin deleted the 433-docs-should-not-be-publishedmade-live-each-time-they-are-updated branch May 11, 2026 18:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs should not be published/made live each time they are updated

4 participants