Skip to content

Commit

Permalink
docs: README, fix imjohnbo#72
Browse files Browse the repository at this point in the history
  • Loading branch information
Jblew committed Aug 18, 2022
1 parent 7546939 commit acf6780
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Issue Bot is a flexible GitHub action that takes care of a few issue related tas
- Makes issue comments linking new and previous issues if `linked-comments` is true
- Assigns new issue only to the _next_ assignee in the list if `rotate-assignees` is true. Useful for duty rotation like first responder.
- Pairs well with [imjohnbo/extract-issue-template-fields](https://github.com/imjohnbo/extract-issue-template-fields) if you'd prefer to open issues based on [issue templates](https://docs.github.com/en/github/building-a-strong-community/about-issue-and-pull-request-templates#issue-templates)
- Supports Projects V2 (previously known as Projects Beta and Projects Next).

## v3 Migration
⚠️ If you're a `v2` user, please note that these breaking changes were introduced in `v3`: ⚠️
Expand Down Expand Up @@ -120,6 +121,29 @@ The linked comments (`linked-comments-new-issue-text`, `linked-comments-previous

- `newIssueNumber`: The new issue number.


## Projects V2 support:

Projects V2 were previously known as Projects Beta and Projects Next.

It works both for user owned projects and organization owned projects. Note that there are no repository owned projects V2.

To use it simply put project url:
```yaml
projectV2: orgs/{name}/projects/{number}
projectV2: users/{name}/projects/{number}
```
e.g.
```
token: ...github_pat_token_with_project_scope
projectV2: orgs/github/projects/2
projectV2: users/octokit/projects/31
```
Please note that Projects V2 are still in beta and they require Github Personal Access Token (PAT) with full 'project' scope. You can set it via the `token:` field.


## Contributing

Feel free to open an issue, or better yet, a
Expand Down

0 comments on commit acf6780

Please sign in to comment.