Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
technote-space committed Aug 27, 2019
1 parent 4d9c3d8 commit e01e12f
Showing 1 changed file with 34 additions and 27 deletions.
61 changes: 34 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,33 +10,34 @@ GitHub actions to auto label a pull request or an issue based on project card mo
## Screenshot

## Installation
`.github/workflows/project_card_moved.yml`
```yaml
on: project_card
name: Project Card Event
jobs:
triage:
name: Auto card labeler
runs-on: ubuntu-latest
steps:
- name: Auto card labeler
uses: technote-space/auto-card-labeler@v1
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```

`.github/card-labeler.yml`
```yaml
Project name1:
Column name1:
- 'Status: test1'
Column name2:
- 'Status: test2-1'
- 'Status: test2-2'
Project name2:
Column name3:
- 'Status: test1'
```
1. Setup workflow
e.g. `.github/workflows/project_card_moved.yml`
```yaml
on: project_card
name: Project Card Event
jobs:
triage:
name: Auto card labeler
runs-on: ubuntu-latest
steps:
- name: Auto card labeler
uses: technote-space/auto-card-labeler@v1
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
1. Setup action setting
e.g. `.github/card-labeler.yml`
```yaml
Project name1:
Column name1:
- 'Status: test1'
Column name2:
- 'Status: test2-1'
- 'Status: test2-2'
Project name2:
Column name3:
- 'Status: test1'
```

## Behavior
e.g.
Expand Down Expand Up @@ -85,6 +86,12 @@ Project name1:
Config file name.
default: `'card-labeler.yml'`

## Action event details
### Target event
- project_card
### Target action
- moved

## Author
[GitHub (Technote)](https://github.com/technote-space)
[Blog](https://technote.space)

0 comments on commit e01e12f

Please sign in to comment.