Automate docs generation #6188
Open
Automate docs generation #6188
Conversation
This file contains 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
pierlon
added
the
Infrastructure
pierlon
force-pushed
the
enhancement/5520-docs-generation
branch
from
3c25c1b
to
4cd77d6
Compare
pierlon
commented
May 10, 2021
| @@ -87,7 +87,6 @@ public function parse_files( $files, $root ) { | |||
| $out = [ | |||
| 'file' => $this->export_docblock( $file ), | |||
| 'path' => str_replace( DIRECTORY_SEPARATOR, '/', $file->getFilename() ), | |||
| 'root' => $root, | |||
There was a problem hiding this comment.
I'm not sure if this key is used anywhere.
With this change the the root key for each file object in the generated JSON file would no longer exist, preventing any unnecessary change to the JSON if it were generated in a different environment from where the docs command was previously run.
Comment on lines
+79
to
+80
| git config user.email "[email protected]" | ||
| git config user.name "Pierre Gordon" |
There was a problem hiding this comment.
The github-actions bot isn't on the CLA allowlist so I'm using myself for now to make commits.
|
Examples of the PRs this workflow would generate: pierlon#11, pierlon#12. |
westonruter
approved these changes
May 24, 2021
|
Plugin builds for 68eb9ed are ready 🛎️!%0A- Download development build%0A- Download production build |
westonruter
reviewed
Jun 16, 2021
| if: steps.changes.outputs.changed == 1 && steps.remote-branch.outputs.exists == 0 | ||
| run: | | ||
| git push -u origin "$HEAD_BRANCH" | ||
| gh pr create --base "$BASE_BRANCH" --title "Update documentation for \`$BASE_BRANCH\` branch" --body "" --label Documentation |
There was a problem hiding this comment.
Do the backticks not get evaluated? I guess not as seen in pierlon#12.
westonruter
approved these changes
Jun 16, 2021
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.
Summary
See #5520
This PR allows one to manually trigger generating the documentation for any branch (that has this workflow file) on demand. Once merged, you will be able to do so by going to the Actions page and clicking on the "Plugin Documentation" workflow on the left. You should then see a notice informing you the workflow can be manually dispatched, with a "Run workflow" button on the right of the notice text. Clicking that button reveals a dropdown that allows one to choose the branch to run the workflow from. Here's an example of such a screen:
Once the workflow run is complete a PR will be created with the updated documentation changes. If there are no changes, no PR is created.
Checklist