fastlane / github-actions

MIT License
75 stars 7 forks source link

Remove a default `pr-comment` message from `communicate-on-pull-request-merged` #21

Closed mollyIV closed 4 years ago

mollyIV commented 5 years ago

Currently there is a default pr-comment message for communicate-on-pull-request-merged Action:

https://github.com/fastlane/github-actions/blob/e0ddd5315eab05c44d27678a99390780a5965d8f/communicate-on-pull-request-merged/action.yml#L8-L14

The message does not contain congrats for a pull request author. Below you will find an original message:

image

To avoid ambiguity, we should delete a default message from an Action and make it required instead.

The workflow file will look like this then:

name: Processing merged pull requests
on: 
  pull_request:
    types: [closed]

jobs:   
  communicate-on-pr-merged:
    name: Communicate on pr merged
    runs-on: ubuntu-latest    
    steps:
    - uses: actions/checkout@master
      with:
        ref: refs/heads/master
    - uses: fastlane/github-actions/communicate-on-pull-request-merged@latest
      with:
        repo-token: "${{ secrets.BOT_TOKEN }}"
        pr-comment: "Hey @${{ github.event.pull_request.user.login }} :wave:\nThank you for your contribution to _fastlane_ and congrats on..."
janpio commented 4 years ago

Why do we not want to offer the possibility to not use a customized pr-comment? I think having safe defaults make sense, which can totally not use the user name.

mollyIV commented 4 years ago

Why do we not want to offer the possibility to not use a customized pr-comment?

github-actions repository was created to store fastlane specific GitHub Actions, not indented to use by broader audience. If we wanted to make a reusable GitHub Action, we would need to create a separate repository dedicated to the action itself (versioning support, etc.).

Taking into account the above, having a default message, that we would not use anyway, introduces ambiguity.

janpio commented 4 years ago

Ok, agree.