https://github.com/jhoblitt/arborist-action

Prune orphaned branches from a forest of repos.
https://github.com/jhoblitt/arborist-action

git github github-actions github-api golang multirepo

Last synced: 1 day ago
JSON representation

Prune orphaned branches from a forest of repos.

• Host: GitHub
• URL: https://github.com/jhoblitt/arborist-action
• Owner: jhoblitt
• License: gpl-3.0
• Created: 2023-06-02T16:44:22.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-06-06T20:01:33.000Z (over 1 year ago)
• Last Synced: 2025-01-29T11:55:32.568Z (6 days ago)
• Topics: git, github, github-actions, github-api, golang, multirepo
• Language: Dockerfile
• Homepage:
• Size: 534 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# arborist-action

GitHub Action to run [`arborist`](https://github.com/jhoblitt/arborist/).

![A Tidy Repo Forest](./images/4193380335_A_lush_forest_of_tall_trees_with_branches_being_cu_xl-beta-v2-2-2.png)

Prune orphaned branches from a forest of repos.

## Usage

### Config File

See [arborist#config-file](https://github.com/jhoblitt/arborist#config-file)

for documentation on the `.arborist.yaml` configuration file.

### Example Workflow

```yaml

---

name: Arborist

"on":

  - create

  - delete

  - pull_request

  - push

permissions:

  contents: write

jobs:

  arborist:

    name: Prune dead branches

    runs-on: ubuntu-latest

    steps:

      - name: Checkout

        uses: actions/checkout@v3

      - name: run arborist

        uses: jhoblitt/arborist-action@v1

        with:

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

```

### Inputs

| Name       | Type   | Required | Description      |

| -          | -      | -        | -                |

| repo-token | String | Yes      | GitHub API Token |

### GitHub API Tokens

Note that the `${{ secrets.GITHUB_TOKEN }}` API token is limited in scope to

the local repository.  If `arborist` needs to be able to prune branches from

remote repositories, then a "Personal Access Token" will need to be created

with the appropriate scope(s).