update composite action

Signed-off-by: Guillaume Falourd <guillaume.falourd@zup.com.br>
datadrivers · Mar 10, 2022 · 4ab77db · 4ab77db
1 parent 858f2e1
commit 4ab77db
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 4 deletions.
diff --git a/.github/workflows/macos_action_test.yml b/.github/workflows/macos_action_test.yml
@@ -13,5 +13,5 @@ jobs:
       - uses: actions/checkout@v2
       - uses: GuillaumeFalourd/pull-request-action@main
         with:
-          destination_branch: "main"
+          destination_branch: "test"
           github_token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/ubuntu_action_test.yml b/.github/workflows/ubuntu_action_test.yml
@@ -13,5 +13,5 @@ jobs:
       - uses: actions/checkout@v2
       - uses: GuillaumeFalourd/pull-request-action@main
         with:
-          destination_branch: "main"
+          destination_branch: "test"
           github_token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/windows_action_test.yml b/.github/workflows/windows_action_test.yml
@@ -13,5 +13,5 @@ jobs:
       - uses: actions/checkout@v2
       - uses: GuillaumeFalourd/pull-request-action@main
         with:
-          destination_branch: "main"
+          destination_branch: "test"
           github_token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/README.md b/README.md
@@ -4,9 +4,38 @@
 
 _**Note**: This action is supported on **all runners** operating systems (`ubuntu`, `macos`, `windows`)_
 
+Inspired from [https://github.com/repo-sync/pull-request](https://github.com/repo-sync/pull-request)
 ## 📚 Usage
 
-TODO
+### Minimum
+
+```yaml
+    - uses: GuillaumeFalourd/pull-request-action@main
+      with:
+        destination_branch: "main"
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+```
+
+### Maximum
+
+```yaml
+    - name: pull-request
+      uses: GuillaumeFalourd/pull-request-action@main
+      uses: repo-sync/pull-request@v2
+      with:
+        source_branch: ""                                 # If blank, default: triggered branch
+        destination_branch: "main"                        # If blank, default: main
+        pr_title: "Pulling ${{ github.ref }} into main"   # Title of pull request
+        pr_body: "An automated PR"                        # Full markdown support, requires pr_title to be set
+        pr_template: ".github/PULL_REQUEST_TEMPLATE.md"   # Path to pull request template, requires pr_title to be set, excludes 
+        pr_reviewer: "john, britney"                      # Comma-separated list (no spaces)
+        pr_assignee: "john"                               # Comma-separated list (no spaces)
+        pr_label: "auto-pr"                               # Comma-separated list (no spaces)
+        pr_milestone: "Milestone 1"                       # Milestone name
+        pr_draft: true                                    # Creates pull request as draft
+        pr_allow_empty: true                              # Creates pull request even if there are no changes
+        github_token: ${{ secrets.GITHUB_TOKEN }}         # If blank, default: GITHUB_TOKEN (can use PAT)
+```
 
 ## 🤝 Contributing