estrada9166/labeler

Clarify README instructions

samajammin opened this issue · 8 comments

Hi & thank you for creating this project!

Could you please clarify your README instructions?

Create a config file in the root of your project

Does this mean create a yml file (e.g. labeler-config.yml) in the root of my .github directory?

Hi! thanks for creating this issue!

It means in the root of the whole project, something like

.
│
├── .github 
│   ├── workflows
│   │    ├── labeler.yml
│   │    └── ...
│   └── ...
├── package.json
├── labeler-config.yml
└── ...

Ok, thanks! If that specific filename (labeler-config.yml) is necessary, I'd suggest adding that to the README.

Looking forward to testing this out!

So must the workflow be named labeler.yml? I'm wondering if this will conflict with our existing workflow file: https://github.com/ethereum/ethereum-org-website/blob/dev/.github/labeler.yml

No! you can use another name... so, it can be something like this

.
│
├── .github 
│   ├── workflows
│   │    ├── labeler-action.yml
│   │    └── ...
│   └── ...
├── package.json
├── labeler-config.yml
└── ...

.github/workflows/labeler-action.yml

name: Labeler

on: [pull_request_review, pull_request_review_comment]

jobs:
  triage:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - name: Labeler
      uses: estrada9166/labeler@v1-release
      with:
        GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
        CONFIG_PATH: labeler-config.yml 

labeler-config.yml

onComment:
  set:
    - WIP

onApproved:
  remove:
    - WIP
  set:
    - First review
    - Ready to merge

onChangesRequested:
  remove:
    - Ready to merge
    - Waiting 1st review
    - Waiting 2nd review
  set:
    - WIP 

@estrada9166 Not sure if anything changed on GitHub side, but when I try to use a config file the action always fails with:

##[error]Error: ENOENT: no such file or directory, open 'labeler-config.yml'
##[error]ENOENT: no such file or directory, open 'labeler-config.yml'
##[error]Node run failed with exit code 1

Workflow file
Config file

Do you have an idea what is going wrong?

Is it just these events we can hook onto?

  • onComment
  • onApproved
  • onChangesRequested

As it would be preferable to add one for onMerged if it's even a thing 😅


EDIT Yep, just those 3 would be great to add onMerged 🙏

@ripcurlx @estrada9166 I'm also facing the same problem, what was your solution?

Looking at another library, I found that they actually place their config within the .github directory... so have updated my PR to solve this issue and trying it on my own repo.
Just waiting on that review 😅