Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: README update for the issue auto-author-assign #83

Merged
merged 3 commits into from
Aug 1, 2022
Merged

doc: README update for the issue auto-author-assign #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5cbe7a9
Disable auto-author-assign for an issue
toshimaru Jul 31, 2022
e5c259b
doc: Add section "Enable auto-author-assign for the issues"
toshimaru Aug 1, 2022
e45d640
chore: Update CHANGELOG heading level
toshimaru Aug 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/dependabot.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ updates:
schedule:
interval: weekly
reviewers:
- toshimaru
- toshimaru
- package-ecosystem: github-actions
directory: /
schedule:
interval: weekly
reviewers:
- toshimaru
- toshimaru
5 changes: 3 additions & 2 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@ name: Auto Author Assign

on:
pull_request_target:
issues:
types: [ opened, reopened ]
# Uncomment if you want to enable auto-author-assign for the issue
# issues:
# types: [ opened, reopened ]

permissions:
issues: write
Expand Down
10 changes: 5 additions & 5 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ All notable changes to this project will be documented in this file. See [standa

## [1.6.0](https://github.com/toshimaru/auto-author-assign/compare/v1.5.1...v1.6.0) (2022-07-28)

### [1.5.1](https://github.com/toshimaru/auto-author-assign/compare/v1.5.0...v1.5.1) (2022-07-22)
## [1.5.1](https://github.com/toshimaru/auto-author-assign/compare/v1.5.0...v1.5.1) (2022-07-22)

### [1.5.0](https://github.com/toshimaru/auto-author-assign/compare/v1.4.0...v1.5.0) (2022-03-28)
## [1.5.0](https://github.com/toshimaru/auto-author-assign/compare/v1.4.0...v1.5.0) (2022-03-28)

### [1.5.0](https://github.com/toshimaru/auto-author-assign/compare/v1.4.0...v1.5.0) (2022-03-28)
## [1.5.0](https://github.com/toshimaru/auto-author-assign/compare/v1.4.0...v1.5.0) (2022-03-28)

### [1.4.0](https://github.com/toshimaru/auto-author-assign/compare/v1.3.7...v1.4.0) (2021-10-17)
## [1.4.0](https://github.com/toshimaru/auto-author-assign/compare/v1.3.7...v1.4.0) (2021-10-17)

### [1.3.7](https://github.com/toshimaru/auto-author-assign/compare/v1.3.6...v1.3.7) (2021-08-29)
## [1.3.7](https://github.com/toshimaru/auto-author-assign/compare/v1.3.6...v1.3.7) (2021-08-29)
27 changes: 22 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,17 @@ This action automatically assigns PR author as an assignee.
name: Auto Author Assign

on:
issues:
types: [ opened, reopened ]
pull_request_target:
types: [ opened, reopened ]

permissions:
issues: write
pull-requests: write

jobs:
assign-author:
runs-on: ubuntu-latest
steps:
- uses: toshimaru/auto-author-assign@v1.6.0

```

## Use your own token
Expand All @@ -48,11 +44,32 @@ jobs:
- uses: toshimaru/auto-author-assign
with:
repo-token: ${{ secrets.YOUR_TOKEN }}

```

If not specified, `GITHUB_TOKEN` will be used by default.

## Enable auto-author-assign for the issues

An issue author can be automatically assigned as an issue assignee.

- Add `issues` to the trigger
- Add `issues: write` to the permissions

```yml
on:
issues:
types: [ opened, reopened ]
pull_request_target:
types: [ opened, reopened ]

permissions:
issues: write
pull-requests: write

jobs:
...
```

## Skip assigning author

`auto-author-assign` action skips assigning the author when:
Expand Down