Skip to content
briefcase

GitHub Action

Team, Assemble!

v1.3 Latest version

Team, Assemble!

briefcase

Team, Assemble!

Provision Teams and Grant Access to Repos

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Team, Assemble!

uses: 01011111/assemble@v1.3

Learn more about this action in 01011111/assemble

Choose a version

Assemble!

Usage

Configuration File

Create a assemble.yml file in your repository.

There's 3 sections to it: teams, access and schemas.

The Teams section will create teams in your organization that is listed in the file but is missing from the organization.
It will not delete teams that exist but are not present in the file.

The Access section will grant access to listed teams with specific permission to listed repositories.
If you want to grant access too all repositories, you can use '*' for the name of the repository (don't forget the quotes or yaml will not consider it a string).

The Schemas section is to define pattern of access that you reuse accross repositories in the access section.

Example

teams:
  - Admin
  - BackEnd
  - DevOps
  - FronEnd
  - QA
  - Mobile

access:
  '*':
    - $refs: '#/schemas/baseline'

  my_repo:
    - team: BackEnd
      permission: maintain
    - team: DevOps
      permission: push
    - team: QA
      permission: triage

schemas:
  baseline:
    - team: Admin
      permission: admin
    - team: QA
      permission: pull

GitHub Workflow

Create a GitHub Workflow with a content similar to this:

name: Check GH Teams

on:
  workflow_dispatch:
  schedule:
    - cron: '37 13 * * *'

jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - uses: 01011111/assemble@1.4
        with:
          token: ${{ secrets.ORG_TOKEN }}

You will need a token that has the admin:org scopes.
You can create a token in the GitHub Developer Settings and add it to your repository secrets.

Using a different file

You can reference a different file for the configuration - but the content has to be yaml.

Just add an input in the workflow:

uses: 01011111/assemble@v1.4
  with:
    token: ${{ secrets.ORG_TOKEN }}
    config: './github_teams.yaml'