Skip to content

Commit

Permalink
Add Workflow for generating Hooks Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
puntope committed Aug 21, 2023
1 parent 25b252e commit ef7100e
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 0 deletions.
58 changes: 58 additions & 0 deletions .github/workflows/php-hook-documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: PHP Hook Documentation Generator

on:
push:
branches:
- "release/**"
paths:
- "**.php"
- .github/workflows/php-hook-documentation.yml
pull_request:
types:
- opened
branches:
- "release/**"
paths:
- "**.php"
- .github/workflows/php-hook-documentation.yml
workflow_dispatch:

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
HookDocumentation:
name: Hook Documentation Generator
runs-on: ubuntu-latest
steps:
- name: Checkout the repository
uses: actions/checkout@v3
with:
# Checks out a branch instead of a commit in detached HEAD state
ref: ${{ github.head_ref }}

# This generates the documentation string. The `id` property is used to reference the output in the next step.
- name: Generate hook documentation
id: generate-hook-docs
uses: woocommerce/grow/hook-documentation@actions-v1
with:
debug-output: yes
source-directories: includes/ woocommerce-google-analytics-integration.php

- name: Commit hook documentation
shell: bash
# Use the github-actions bot account to commit.
# https://api.github.com/users/github-actions%5Bbot%5D
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
echo "${{ steps.generate-hook-docs.outputs.hook-docs }}" > docs/Hooks.md
git add docs/Hooks.md
if git diff --cached --quiet; then
echo "*No documentation changes to commit.*" >> $GITHUB_STEP_SUMMARY
else
echo "*Committing documentation changes.*" >> $GITHUB_STEP_SUMMARY
git commit -q -m "Update hooks documentation from ${{ github.head_ref }} branch."
git push
fi
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,7 @@ _For more info see: [WordPress.org > Plugin Unit Tests](https://make.wordpress.o
2. Run `npm run lint:php`

Alternatively, run `npm run lint:php:diff` to run coding standards checks agains the current git diff. An explanation of output can be [found here](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Usage#printing-progress-information) e.g. what are the S's?

## Docs

- [Hooks defined or used in WooCommerce Google Analytics Integration](./docs/Hooks.md)
Empty file added docs/Hooks.md
Empty file.

0 comments on commit ef7100e

Please sign in to comment.