Release/test hooks

.github/workflows/php-hook-documentation.yml

@@ -0,0 +1,49 @@
+name: PHP Hook Documentation Generator
+
+on:
+  push:
+    branches:
+      - "release/**"
+    paths:
+      - changelog.txt # Run the workflow only after the last commit of Woo Release. When it updates the changelog.
+  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

README.md

@@ -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)

changelog.txt

@@ -1,5 +1,7 @@
 *** Changelog ***
 
+test
+
 = 1.8.4 - 2023-08-08 =
 * Dev - Add release preparation GH workflow.
 * Fix - Add async attribute in `google-tag-manager` script.

docs/Hooks.md

@@ -0,0 +1,141 @@
+# Hooks Reference
+
+A list of hooks, e.g. `actions` and `filters`, that are defined or used in this project.
+
+## wc_google_analytics_send_pageview
+
+**Type**: filter
+
+**Used in**:
+
+- [class-wc-google-analytics-js.php#L192](https://github.com/woocommerce/woocommerce-google-analytics-integration/blob/60029d985e86663e16327c9e81ffc25abceb3fb3/includes/class-wc-google-analytics-js.php#L192)
+
+## woocommerce_cart_item_product
+
+**Type**: filter
+
+**Used in**:
+
+- [class-wc-google-gtag-js.php#L443](https://github.com/woocommerce/woocommerce-google-analytics-integration/blob/60029d985e86663e16327c9e81ffc25abceb3fb3/includes/class-wc-google-gtag-js.php#L443)
+- [class-wc-google-analytics-js.php#L482](https://github.com/woocommerce/woocommerce-google-analytics-integration/blob/60029d985e86663e16327c9e81ffc25abceb3fb3/includes/class-wc-google-analytics-js.php#L482)
+
+## woocommerce_ga_classic_snippet_output
+
+**Type**: filter
+
+**Used in**:
+
+- [class-wc-google-analytics-js.php#L105](https://github.com/woocommerce/woocommerce-google-analytics-integration/blob/60029d985e86663e16327c9e81ffc25abceb3fb3/includes/class-wc-google-analytics-js.php#L105)
+
+## woocommerce_ga_disable_tracking
+
+**Type**: filter
+
+**Used in**:
+
+- [class-wc-google-analytics.php#L503](https://github.com/woocommerce/woocommerce-google-analytics-integration/blob/60029d985e86663e16327c9e81ffc25abceb3fb3/includes/class-wc-google-analytics.php#L503)
+
+## woocommerce_ga_event_tracking_parameters
+
+**Type**: filter
+
+**Used in**:
+
+- [class-wc-google-analytics-js.php#L509](https://github.com/woocommerce/woocommerce-google-analytics-integration/blob/60029d985e86663e16327c9e81ffc25abceb3fb3/includes/class-wc-google-analytics-js.php#L509)
+
+## woocommerce_ga_snippet_create
+
+**Type**: filter
+
+**Used in**:
+
+- [class-wc-google-analytics-js.php#L283](https://github.com/woocommerce/woocommerce-google-analytics-integration/blob/60029d985e86663e16327c9e81ffc25abceb3fb3/includes/class-wc-google-analytics-js.php#L283)
+
+## woocommerce_ga_snippet_developer_id
+
+**Type**: filter
+
+**Used in**:
+
+- [class-wc-google-analytics-js.php#L284](https://github.com/woocommerce/woocommerce-google-analytics-integration/blob/60029d985e86663e16327c9e81ffc25abceb3fb3/includes/class-wc-google-analytics-js.php#L284)
+
+## woocommerce_ga_snippet_head
+
+**Type**: filter
+
+**Used in**:
+
+- [class-wc-google-analytics-js.php#L282](https://github.com/woocommerce/woocommerce-google-analytics-integration/blob/60029d985e86663e16327c9e81ffc25abceb3fb3/includes/class-wc-google-analytics-js.php#L282)
+
+## woocommerce_ga_snippet_output
+
+**Type**: filter
+
+**Used in**:
+
+- [class-wc-google-analytics-js.php#L289](https://github.com/woocommerce/woocommerce-google-analytics-integration/blob/60029d985e86663e16327c9e81ffc25abceb3fb3/includes/class-wc-google-analytics-js.php#L289)
+
+## woocommerce_ga_snippet_require
+
+**Type**: filter
+
+**Used in**:
+
+- [class-wc-google-analytics-js.php#L285](https://github.com/woocommerce/woocommerce-google-analytics-integration/blob/60029d985e86663e16327c9e81ffc25abceb3fb3/includes/class-wc-google-analytics-js.php#L285)
+
+## woocommerce_ga_tracker_variable
+
+**Type**: filter
+
+**Used in**:
+
+- [class-wc-google-analytics-js.php#L44](https://github.com/woocommerce/woocommerce-google-analytics-integration/blob/60029d985e86663e16327c9e81ffc25abceb3fb3/includes/class-wc-google-analytics-js.php#L44)
+
+## woocommerce_google_analytics_script_src
+
+**Type**: filter
+
+**Used in**:
+
+- [class-wc-google-analytics-js.php#L242](https://github.com/woocommerce/woocommerce-google-analytics-integration/blob/60029d985e86663e16327c9e81ffc25abceb3fb3/includes/class-wc-google-analytics-js.php#L242)
+
+## woocommerce_gtag_event_data
+
+**Type**: filter
+
+**Used in**:
+
+- [class-wc-google-gtag-js.php#L126](https://github.com/woocommerce/woocommerce-google-analytics-integration/blob/60029d985e86663e16327c9e81ffc25abceb3fb3/includes/class-wc-google-gtag-js.php#L126)
+
+## woocommerce_gtag_event_tracking_parameters
+
+**Type**: filter
+
+**Used in**:
+
+- [class-wc-google-gtag-js.php#L486](https://github.com/woocommerce/woocommerce-google-analytics-integration/blob/60029d985e86663e16327c9e81ffc25abceb3fb3/includes/class-wc-google-gtag-js.php#L486)
+
+## woocommerce_gtag_snippet
+
+**Type**: filter
+
+**Used in**:
+
+- [class-wc-google-gtag-js.php#L327](https://github.com/woocommerce/woocommerce-google-analytics-integration/blob/60029d985e86663e16327c9e81ffc25abceb3fb3/includes/class-wc-google-gtag-js.php#L327)
+
+## woocommerce_gtag_tracker_variable
+
+**Type**: filter
+
+**Used in**:
+
+- [class-wc-google-gtag-js.php#L88](https://github.com/woocommerce/woocommerce-google-analytics-integration/blob/60029d985e86663e16327c9e81ffc25abceb3fb3/includes/class-wc-google-gtag-js.php#L88)
+
+## plugin_locale
+
+**Type**: filter
+
+**Used in**:
+
+- [woocommerce-google-analytics-integration.php#L135](https://github.com/woocommerce/woocommerce-google-analytics-integration/blob/60029d985e86663e16327c9e81ffc25abceb3fb3/woocommerce-google-analytics-integration.php#L135)
+