Update README.md

tj-actions · Nov 7, 2021 · b48ced7 · b48ced7
1 parent 2033609
commit b48ced7
Showing 1 changed file with 33 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -54,6 +54,39 @@ branding:
   ...
 ```
 
+## Examples
+Create a pull request each time the action.yml inputs/outputs change
+
+```yaml
+...
+     steps:
+       - name: Checkout
+         uses: actions/checkout@v2.4.0
+         with:
+           fetch-depth: 0  # otherwise, you will failed to push refs to dest repo
+
+       - name: Run auto-doc
+         uses: tj-actions/auto-doc@v1.1.4
+
+       - name: Verify Changed files
+         uses: tj-actions/verify-changed-files@v8.6
+         id: verify-changed-files
+         with:
+           files: |
+             README.md
+
+       - name: Create Pull Request
+         if: steps.verify-changed-files.outputs.files_changed == 'true'
+         uses: peter-evans/create-pull-request@v3
+         with:
+           base: "main"
+           title: "auto-doc: Updated README.md"
+           branch: "chore/auto-doc-update-readme"
+           commit-message: "auto-doc: Updated README.md"
+           body: "auto-doc: Updated README.md"
+```
+
+
 ### Using CLI
 
 #### Installation