Added ability to pass in an optional PR number as a parameter

[credfeto]

So so it can be used in a workflow that creates a PR automatically like repo-sync/pull-request then add in labels at creation rather than having to run an additional workflow

name: Auto PR Creation
on:
  push:
    branches-ignore:
    - master
    - main

jobs:
  create-pull-request:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3
      with:
        fetch-depth: 1
        token: ${{ secrets.GITHUB_TOKEN }}
    - run: |
        echo COMMIT_MSG=`git log -1 --pretty=%B` >> $GITHUB_ENV

    - id: open-pr
      uses: repo-sync/pull-request@v2.6
      with:
        source_branch: ""                     # If blank, default: triggered branch
        destination_branch: "main"            # If blank, default: master
        pr_assignee: "${{ github.actor }}"    # Comma-separated list (no spaces)
        pr_label: "auto-pr"                   # Comma-separated list (no spaces)
        pr_draft: true                        # Creates pull request as draft
        pr_title: "${{ env.COMMIT_MSG }}"
        pr_body: "${{ steps.pr-template.outputs.content }}"
        github_token: ${{ secrets.GITHUB_TOKEN }}

    - name: Details
      run: |
          echo "URL: ${{steps.open-pr.outputs.pr_url}}"
          echo "PR: ${{steps.open-pr.outputs.pr_number}}"
          echo "CF: ${{steps.open-pr.outputs.has_changed_files}}"

    - uses: credfeto/labeler@feature/pass-in-pull-request-or-issue
      with:
        repo-token: "${{ secrets.GITHUB_TOKEN }}"
        configuration-path: .github/labeler.yml
        sync-labels: true
        pr-number: ${{steps.open-pr.outputs.pr_number}}

Also would fix #304

[AndreiLobanovich]

Hello, @credfeto!

First of all, I want to thank you for the time and effort you've put into creating this pull request. We greatly appreciate contributions from our community and we recognize the value they bring to the continual improvement of our project.

Regarding your changes, I appreciate your insights and your attempt to refine the workings of the labeler action. However, it's worth noting that in the current setup, any PR created triggers the pull_request_target event. So any PR created gets labeled.

As for the issue you have mentioned, the proper way to label pull requests which were created before adding the labeler workflow would be pulling changes from the main branch (the newly added workflow) to your branch - that will trigger the pull_request_target event as well.

If I have missed any other use cases, feel free to propose them for consideration.

Best regards.

[credfeto]

@AndreiLobanovich, my use case is slightly different - I've got a github action that creates a PR - which uses the github.token to create a PR as its trying to pick up branches that have been left dormant and not merged and make them visible so some sort of action can occur (e.g. continue work, merge, delete branch). as I can't impersonate whoever has worked on that branch, I've used the github token to create the PR. This wasn't triggering other workflows. If I used my user then due to policies prohibiting admin merge in some of the repos its used in, I wouldn't be able to merge any of the PRs that it created e.g:

      - id: open-pr
        uses: repo-sync/pull-request@v2.12
        with:
          source_branch: ""                     # If blank, default: triggered branch
          destination_branch: "main"            # If blank, default: master
          pr_assignee: ${{github.actor}}      # Comma-separated list (no spaces)
          pr_label: "auto-pr"                   # Comma-separated list (no spaces)
          pr_draft: ${{env.CREATE_DRAFT}}                        # Creates pull request as draft
          pr_title: ${{env.COMMIT_MSG}}
          pr_body: ${{steps.pr-template.outputs.content}}
          github_token: ${{github.token}}
          
     ## using forked verson of actions/labeler to get the pr_number that was created to add labels
      - uses: credfeto/labeler@feature/pass-in-pull-request-or-issue
        with:
          repo-token: ${{secrets.SOURCE_PUSH_TOKEN}}
          configuration-path: .github/labeler.yml
          sync-labels: true
          pr-number: ${{steps.open-pr.outputs.pr_number}}

Full workflow

[AndreiLobanovich]

Hey, @credfeto, I have tested your implementation, it works well. Also, we have a feature request for labeling multiple pull request with a single run. We think that making this input able to accept not only a single pr number but also a list of pr numbers is a way to go. Could you implement this functionality?
The input should accept pr numbers in the following manner:

pr-number: |
  prnumber1
  prnumber2
  prnumber3
  etc

Additionally, please, consider adding checks for the input data.

[credfeto]

@AndreiLobanovich, thanks.

I'll take a look at adding the multiple PRs and the validation. WRT the validation how far should i go - e.g - is it enough to check that its a valid positive number, or should it validate that it is an [open?] PR or issue?

[AndreiLobanovich]

@credfeto I think we should check the input if it's a positive number and try to get the PR. If retrieval fails there should be a core.warning to notify the user that there is no such PR.

[AndreiLobanovich]

Thanks for your effort! Just a few minor changes needed.

[MaksimZhukov]

Hello @credfeto!
I would like to inquire about your progress, do you need any help from our side?

[credfeto]

Hello @credfeto! I would like to inquire about your progress, do you need any help from our side?

All's fine - I've just been busy the last couple of weeks - just need to pick things up again fix up the issues reported. Hopefully will get that done today or tomorrow

[credfeto]

I think I've addressed all your comments above; let me know if there's anything I've missed

[credfeto]

@MaksimZhukov Fixed the tests - had to revert one of the suggested fixes to get it to work

The comments were resolved

[MaksimZhukov]

Thank you @credfeto for the contribution!