From 4ab77dbfc5c23a1d02eb07e36f09e6107f4ab42d Mon Sep 17 00:00:00 2001 From: Guillaume Falourd Date: Thu, 10 Mar 2022 10:54:19 -0300 Subject: [PATCH] update composite action Signed-off-by: Guillaume Falourd --- .github/workflows/macos_action_test.yml | 2 +- .github/workflows/ubuntu_action_test.yml | 2 +- .github/workflows/windows_action_test.yml | 2 +- README.md | 31 ++++++++++++++++++++++- 4 files changed, 33 insertions(+), 4 deletions(-) diff --git a/.github/workflows/macos_action_test.yml b/.github/workflows/macos_action_test.yml index 9f5ff27..c65845c 100644 --- 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 }} \ No newline at end of file diff --git a/.github/workflows/ubuntu_action_test.yml b/.github/workflows/ubuntu_action_test.yml index f620bd4..3dfbabd 100644 --- 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 }} \ No newline at end of file diff --git a/.github/workflows/windows_action_test.yml b/.github/workflows/windows_action_test.yml index 876a85c..4377ad1 100644 --- 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 }} \ No newline at end of file diff --git a/README.md b/README.md index 2dcf48a..95a4b17 100644 --- 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