Add new input to show created PR link on action run page

[ybiquitous]

Hello. I'm sorry if this feature request was already duplicated. Please feel free to reject it then.

In this issue, I want to suggest a new input to show a created PR in a notice message on an action run page like this:

This feature should be disabled by default, but when users want, it might be helpful because they could easily find a created or updated PR on action log pages.

Since we don't have this feature for now, we must write more workflow code to achieve the same thing. However, if the feature were added, we could just enable the input. For example:

Before:

- name: Create pull request
  id: cpr
  uses: peter-evans/create-pull-request@v7

- name: Show pull request
  if: ${{ steps.cpr.outputs.pull-request-url && steps.cpr.outputs.pull-request-operation != 'none' }}
  env:
    PR_URL: ${{ steps.cpr.outputs.pull-request-url }}
    PR_OPERATION: ${{ steps.cpr.outputs.pull-request-operation }}
  run: |
    echo "::notice::${PR_URL} was ${PR_OPERATION}."

After:

- name: Create pull request
  uses: peter-evans/create-pull-request@v7
  with:
    message-on-success: true

I don't find any downsides now, but please let me know if any. Or close my suggestion if you have any justification.
Thank you for taking the time to read this.

[peter-evans]

Hi @ybiquitous

Thank you for opening this issue.

I think for now I would prefer if this was just a separate step after the action runs, exactly as you've done. The main reason is that I try really hard not to add inputs to the action unless they are really necessary. I really want to keep the action interface simple, and prevent the action from becoming bloated with features.

This is cool idea that I've not seen before, though. So I would be happy if you want to add it to the misc workflow tips in the documentation.

Also, if this becomes a highly requested feature and a lot of users see value in it then I might change my mind in future. 😄

[ybiquitous]

@peter-evans Thank you for the comment. I just understood your efforts to make the interface as simple as possible. 😃

I will make sure to improve the examples document, as you suggested. Thanks. 💪🏼