https://github.com/marcoeidinger/swift-api-assign-reviewer

GitHub action to detect access control changes (open/public) in Swift files and set reviewer/assignee to pull request
https://github.com/marcoeidinger/swift-api-assign-reviewer

actions github-actions swift

Last synced: 18 days ago
JSON representation

GitHub action to detect access control changes (open/public) in Swift files and set reviewer/assignee to pull request

• Host: GitHub
• URL: https://github.com/marcoeidinger/swift-api-assign-reviewer
• Owner: MarcoEidinger
• License: mit
• Created: 2020-03-27T04:34:07.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T02:43:42.000Z (about 2 years ago)
• Last Synced: 2024-12-14T22:47:47.022Z (about 1 month ago)
• Topics: actions, github-actions, swift
• Language: TypeScript
• Homepage:
• Size: 1.65 MB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Build](https://github.com/MarcoEidinger/swift-api-assign-reviewer/workflows/Build/badge.svg)

[![codecov](https://codecov.io/gh/MarcoEidinger/swift-api-assign-reviewer/branch/master/graph/badge.svg)](https://codecov.io/gh/MarcoEidinger/swift-api-assign-reviewer)

# swift-api-assign-reviewer

GitHub action to detect access control changes (open/public) in Swift files and set reviewer/assignee to pull request 

Example

```yml

name: API-Protection

on:

  pull_request:

    types: [opened, synchronize]

jobs:

  auto-assign-reviewer:

    runs-on: ubuntu-latest

    steps:

      - uses: MarcoEidinger/[email protected]

        with:

          repo-token: "${{ secrets.GITHUB_TOKEN }}"

          configuration-path: ".github/swift-api-assign-reviewer.yml"

```

## Configuration

Define a **configuration** file in your repository, e.g `.github/swift_api_assign_reviewer.yml`

### Example

```yml

# Set to true to add reviewers to pull requests

addReviewers: true

# Set to true to add assignees to pull requests

addAssignees: false

# A list of reviewers to be added to pull requests (GitHub user name)

reviewers:

  - MarcoEidinger

# A number of reviewers added to the pull request

# Set 0 to add all the reviewers (default: 0)

numberOfReviewers: 0

```

### Full Specification

```yml

# Set to true to add reviewers to pull requests

addReviewers: true

# Set to true to add assignees to pull requests

addAssignees: false

# A list of reviewers to be added to pull requests (GitHub user name)

reviewers:

  - reviewerA

  - reviewerB

  - reviewerC

# A number of reviewers added to the pull request

# Set 0 to add all the reviewers (default: 0)

numberOfReviewers: 0

# A list of assignees, overrides reviewers if set

# assignees:

#   - assigneeA

# A number of assignees to add to the pull request

# Set to 0 to add all of the assignees.

# Uses numberOfReviewers if unset.

# numberOfAssignees: 2

```