GH Pages/GH Actions: generate the documentation instead of committing it #419
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.
Generate the documentation instead of committing it - step 1
This removes all files containing some form of "generated" documentation.
This includes:
index.md
file which is based on theREADME.md
file in the project root.The configuration, structure and asset files for generating the documentation website remain.
Generate the documentation instead of committing it - step 2
This commit adds the following:
This workflow will:
docs
directory.docs
directory.Both the configuration and structure files which live in the repo, as well as the generated files are used for this.
.github/GHPages
directory to be used during the build process to:README.md
file to thedocs
directory to document how the documentation generation works and how to send in updates for the website.Additionally, the following changes were made:
The phpDocumentor configuration will be updated as part of the workflow run to add the version number (via one of the scripts).
release-checklist.md
file has been updated to match the new process..github/GHPages
directory are not part of the package, but effectively "dev-tools", these scripts have been written with a PHP 7.2 minimum in mind. The CI PHP linting commands have been updated to allow for this.Notes:
The
ghpages.yml
workflow is can now be removed. That workflow was used to test whether the site could be build correctly, but is no longer needed now theupdate-docs.yml
workflow does a dry-run whenever relevant.