https://github.com/030/settings-action
Settings Action configures the settings of a GitHub repository.
https://github.com/030/settings-action
composite-action github-project-setup github-settings settings-as-code
Last synced: 1 day ago
JSON representation
Settings Action configures the settings of a GitHub repository.
- Host: GitHub
- URL: https://github.com/030/settings-action
- Owner: 030
- License: mit
- Created: 2024-02-17T14:42:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-07-06T11:40:11.000Z (3 months ago)
- Last Synced: 2025-07-16T14:55:33.686Z (3 months ago)
- Topics: composite-action, github-project-setup, github-settings, settings-as-code
- Language: Python
- Size: 19.5 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# settings-action
Settings Action that will configure the settings of a GitHub repository.
## Usage
Create a `~/.github/workflows/settings-guard.yml` file:
```bash
---
name: settings-guard
'on':
schedule:
- cron: '42 6 * * *'
permissions: {}
jobs:
settings-action:
runs-on: ubuntu-22.04
steps:
- uses: 030/settings-action@v0.8.0
env:
GH_TOKEN: ${{ secrets.SETTINGS_GUARD }}
with:
debug: false
description: "Settings Action configures the settings of a GitHub repository."
project: 030/settings-guard
settings_default_workflow_permissions: "read"
settings_delete_branch_on_merge: true
settings_discussions: false
settings_github_workflows_can_approve_pull_request_reviews: true
settings_merge_commit: false
settings_merge_rebase: false
settings_merge_squash: true
settings_protect_main_branch: true
settings_protect_main_branch_enforce_admins: true
settings_protect_main_branch_required_approving_review_count: 1
settings_projects: false
settings_wiki: false
topics: composite-action,github-project-setup,github-settings,settings-as-code
```
use the following variables:
| Option | Description |
| ------------------------------------------------------------ | ------------------------------------------------------------------ |
| debug | Enable debug logging |
| description | Change the description of a GitHub repository |
| project | The owner/repo |
| settings_default_workflow_permissions | Set the default workflow permissions to read or write |
| settings_delete_branch_on_merge | Delete a branch on merge or not |
| settings_discussions | Enable the discussions tab or not |
| settings_github_workflows_can_approve_pull_request_reviews | Whether workflows can approve pull requests |
| settings_merge_commit | Enable merge commit |
| settings_merge_rebase | Enable merge request rebase |
| settings_merge_squash | Enable merge request squash |
| settings_protect_main_branch | Protect the main branch or not |
| settings_protect_main_branch_enforce_admins | Enforce branch protection for admins |
| settings_protect_main_branch_required_approving_review_count | The number of approvals that is required before a PR can be merged |
| settings_projects | Whether the project tab should be enabled |
| settings_wiki | Wiki enabled or not |
| topics | The topic(s) that will appear in the about menu of a project |
and create a token with read and admin permissions and store it as a
`SETTINGS_GUARD` variable in the variables menu.
## Testing
- [Install](https://github.com/cli/cli?tab=readme-ov-file#installation) gh cli.
- Create a read only token.
- Login: `gh auth login` and `choose token` option.
- Check [these graphql samples](https://gist.github.com/duboisf/68fb6e22ac0a2165ca298074f0e3b553)
that can be useful while testing.