-
Notifications
You must be signed in to change notification settings - Fork 18
Docs should not be published/made live each time they are updated #433
Copy link
Copy link
Open
Labels
workflowTasks involving automation processes using CI/CD tools like GitHub ActionsTasks involving automation processes using CI/CD tools like GitHub Actions
Description
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
- Set our AsciiDoc workflow at
.github/workflows/asciidoc-build.ymlto run upon a pull request tomainordevelop. This is because we want the AsciiDoc syntax validated whenever a PR is made. - REMOVE the setting to run
asciidoc-buildon push tomain. - Allow
asciidoc-buildto run when called on. - Separate out the GitHub Pages deployment step from
asciidoc-build.yml. Place it into its own YAML workflow, to be run only on push tomain. In this new file, call theasciidoc-buildworkflow and then the portion that was cut out of the other workflow to push to GitHub Pages.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
workflowTasks involving automation processes using CI/CD tools like GitHub ActionsTasks involving automation processes using CI/CD tools like GitHub Actions
Type
Projects
Status
🔖 Ready