actions-settings

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

actions-settings

(★ 19)

GitHub Actions to run Probot settings and set defaults

actions-settings Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

> **Archived because there are now much better ways to set and enforce repository configuration:**
> 1. [GitHub Safe-Settings](https://github.com/github/safe-settings) - Recommended for configuring repository settings organization-wide
> 2. [GitHub Repository Rulesets](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets) - Native solution for branch protections, either organization-wide or on particular repositories.

# actions-settings
GitHub Action to run [Probot settings](https://github.com/probot/settings) to set repository defaults.

This action simply runs probot-settings, which can be used to set up labels, branch protection rules -- pretty much anything on the repository settings tab. Settings are read from a yaml file in the repository.

## Example Use

Example `probot-settings.yml` file:

```yaml
name: Enforce repository settings

on: [push]

jobs:
  probot-settings:

runs-on: ubuntu-latest

steps:
    - uses: actions/checkout@v2
    - name: Run probot-settings
      uses: elstudio/actions-settings@v2
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```

### A fancer example

Let's say you run `probot-settings` just one time. (Which is useful if you're setting up labels when a repository is first created.)

Fancier example `probot-settings.yml` file:

```yaml
name: Enforce repository settings just once

on: [push]

jobs:
  probot-settings:

runs-on: ubuntu-latest

steps:
    - uses: actions/checkout@v2
    - name: Run probot-settings
      uses: elstudio/actions-settings@v2
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Remove workflow file from master branch
      run: rm ./.github/workflows/probot-settings.yml
      if: endsWith(github.ref, '/master') && ! endsWith(github.repository, '-template')

- name: Commit changes
      uses: elstudio/actions-js-build/commit@v3
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```

actions-settings

actions-settings Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

actions-settings

actions-settings Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README