Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8436f278d0 | ||
|
|
b3c7084018 | ||
|
|
187d5cb76c | ||
|
|
7b6e5d609a | ||
|
|
502b44798b | ||
|
|
dbb409409b |
86
README.md
86
README.md
@@ -1,52 +1,72 @@
|
||||
# GitHub Action for GitHub
|
||||
|
||||
🚨 **This action is deprecated! Please use [actions/github-script](https://github.com/actions/github-script), instead.**
|
||||
|
||||
This action conveniently wraps [actions-toolkit](https://github.com/JasonEtco/actions-toolkit), making it simple to do things like label, assign, and comment on issues on GitHub.
|
||||
|
||||
Here are a few use cases for this action:
|
||||
|
||||
## Applying a "triage" label on any new issue:
|
||||
|
||||
```workflow
|
||||
workflow "Triage" {
|
||||
on = "issue"
|
||||
resolves = "Apply Triage Label"
|
||||
}
|
||||
|
||||
action "Apply Triage Label" {
|
||||
uses = "actions/github@v1.0.0"
|
||||
args = "label triage --action=opened" # Only when issues are opened!
|
||||
secrets = ["GITHUB_TOKEN"]
|
||||
}
|
||||
```yml
|
||||
name: Triage
|
||||
on:
|
||||
issues:
|
||||
types: [opened]
|
||||
jobs:
|
||||
applyTriageLabel:
|
||||
name: Apply Triage Label
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Apply Triage Label
|
||||
uses: actions/github@v1.0.0
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
args: label triage
|
||||
```
|
||||
|
||||
## Commenting on an issue
|
||||
|
||||
```workflow
|
||||
workflow "Triage" {
|
||||
on = "issue"
|
||||
resolves = "Comment On New Issues"
|
||||
}
|
||||
|
||||
action "Comment On New Issues" {
|
||||
uses = "actions/github@v1.0.0"
|
||||
args = "comment "Hello World" --action=opened" # Only when issues are opened!
|
||||
secrets = ["GITHUB_TOKEN"]
|
||||
}
|
||||
```yml
|
||||
name: Triage
|
||||
on:
|
||||
issues:
|
||||
types: [opened]
|
||||
jobs:
|
||||
commentOnNewIssues:
|
||||
name: Comment On New Issues
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Comment On New Issues
|
||||
uses: actions/github@v1.0.0
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
args: comment "Hello World"
|
||||
```
|
||||
|
||||
## Assigning any newly created issues
|
||||
|
||||
```workflow
|
||||
workflow "Triage" {
|
||||
on = "issue"
|
||||
resolves = "Assign MonaLisa"
|
||||
}
|
||||
|
||||
action "Assign MonaLisa" {
|
||||
uses = "actions/github@v1.0.0"
|
||||
args = "assign @monalisaoctocat --action=opened" # Only when issues are opened!
|
||||
secrets = ["GITHUB_TOKEN"]
|
||||
}
|
||||
```yml
|
||||
name: Triage
|
||||
on:
|
||||
issues:
|
||||
types: [opened]
|
||||
jobs:
|
||||
assignMonaLisa:
|
||||
name: Assign MonaLisa
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Assign MonaLisa
|
||||
uses: actions/github@v1.0.0
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
args: assign @monalisaoctocat
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
Reference in New Issue
Block a user