Skip to content

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

@leandrumartin

Description

@leandrumartin

Currently, our live documentation site at https://oss-slu.github.io/Pi4Micronaut/ is updated upon each pull request to the develop branch. However, this means that changes that have not yet been pushed to the Maven repository, and therefore changes that have not yet been made available for people to import, are being documented. This could lead to confusion when somebody sees something documented online, only to find that functionality is not available when they import and use our library.

Our documentation should not be updated each time a merge is made to develop.

To do

  1. Set our AsciiDoc workflow at .github/workflows/asciidoc-build.yml to run upon a pull request to main or develop. This is because we want the AsciiDoc syntax validated whenever a PR is made.
  2. REMOVE the setting to run asciidoc-build on push to main.
  3. Allow asciidoc-build to run when called on.
  4. Separate out the GitHub Pages deployment step from asciidoc-build.yml. Place it into its own YAML workflow, to be run only on push to main. In this new file, call the asciidoc-build workflow and then the portion that was cut out of the other workflow to push to GitHub Pages.

Metadata

Metadata

Assignees

No one assigned

    Labels

    workflowTasks involving automation processes using CI/CD tools like GitHub Actions

    Type

    Projects

    Status

    🔖 Ready

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions