Merge pull request #54 from weierophinney/examples/use-normal-token-for-bump-action

Update workflow documentation and examples

Author: Ocramius

README.md

@@ -113,3 +113,23 @@ That's done by merging the destination into the merge-up branch and resolving th
 1. Push (`git push`)
 
 If needed you can create a merge-up branch manually: `git checkout 1.0.x && git checkout -b 1.0.x-merge-up-into-1.1.x`
+
+## Triggering release workflow events
+
+Because the tokens generated by GitHub Actions are considered OAuth tokens,
+they are incapable of triggering further workflow events ([see this document for
+an explanation](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#triggering-new-workflows-using-a-personal-access-token)).
+
+As such, if you want to trigger a release event when automatic-releases runs,
+you will need to modify your `.github/workflows/release-on-milestone-closed.yml`
+file to assign the `ORGANIZATION_ADMIN_TOKEN` as the value of the
+`GITHUB_TOKEN` environment variable for the `Release` step:
+
+```yaml
+    - name: "Release"
+      uses: "./"
+      with:
+        command-name: "laminas:automatic-releases:release"
+      env:
+        "GITHUB_TOKEN": ${{ secrets.ORGANIZATION_ADMIN_TOKEN }}
+```

examples/.github/workflows/release-on-milestone-closed.yml

@@ -51,7 +51,7 @@ jobs:
         with:
           command-name: "laminas:automatic-releases:bump-changelog"
         env:
-          "GITHUB_TOKEN": ${{ secrets.ORGANIZATION_ADMIN_TOKEN }}
+          "GITHUB_TOKEN": ${{ secrets.GITHUB_TOKEN }}
           "SIGNING_SECRET_KEY": ${{ secrets.SIGNING_SECRET_KEY }}
           "GIT_AUTHOR_NAME": ${{ secrets.GIT_AUTHOR_NAME }}
           "GIT_AUTHOR_EMAIL": ${{ secrets.GIT_AUTHOR_EMAIL }}