docs: added short description for pretty command #7991
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # This workflow is centrally managed in https://github.com/asyncapi/.github/ | |
| # Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in above mentioned repo | |
| # Purpose of this workflow is to enable anyone to label issue with 'Good First Issue' and 'area/*' with a single command. | |
| name: Add 'Good First Issue' and 'area/*' labels # if proper comment added | |
| on: | |
| issue_comment: | |
| types: | |
| - created | |
| jobs: | |
| add-labels: | |
| if: ${{(!github.event.issue.pull_request && github.event.issue.state != 'closed' && github.actor != 'asyncapi-bot') && (contains(github.event.comment.body, '/good-first-issue') || contains(github.event.comment.body, '/gfi' ))}} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Add label | |
| uses: actions/github-script@v6 | |
| with: | |
| github-token: ${{ secrets.GH_TOKEN }} | |
| script: | | |
| const areas = ['javascript', 'typescript', 'java' , 'go', 'docs', 'ci-cd', 'design']; | |
| const words = context.payload.comment.body.trim().split(" "); | |
| const areaIndex = words.findIndex((word)=> word === '/gfi' || word === '/good-first-issue') + 1 | |
| let area = words[areaIndex]; | |
| switch(area){ | |
| case 'ts': | |
| area = 'typescript'; | |
| break; | |
| case 'js': | |
| area = 'javascript'; | |
| break; | |
| case 'markdown': | |
| area = 'docs'; | |
| break; | |
| } | |
| if(!areas.includes(area)){ | |
| const message = `Hey @${context.payload.sender.login}, your message doesn't follow the requirements, you can try \`/help\`.` | |
| await github.rest.issues.createComment({ | |
| issue_number: context.issue.number, | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| body: message | |
| }) | |
| } else { | |
| // remove area if there is any before adding new labels. | |
| const currentLabels = (await github.rest.issues.listLabelsOnIssue({ | |
| issue_number: context.issue.number, | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| })).data.map(label => label.name); | |
| const shouldBeRemoved = currentLabels.filter(label => (label.startsWith('area/') && !label.endsWith(area))); | |
| shouldBeRemoved.forEach(label => { | |
| github.rest.issues.deleteLabel({ | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| name: label, | |
| }); | |
| }); | |
| // Add new labels. | |
| github.rest.issues.addLabels({ | |
| issue_number: context.issue.number, | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| labels: ['good first issue', `area/${area}`] | |
| }); | |
| } |