Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wndhydrnt/saturn-bot
Create, modify or delete files across many repositories in parallel.
https://github.com/wndhydrnt/saturn-bot
gitops golang refactoring
Last synced: 9 days ago
JSON representation
Create, modify or delete files across many repositories in parallel.
- Host: GitHub
- URL: https://github.com/wndhydrnt/saturn-bot
- Owner: wndhydrnt
- License: agpl-3.0
- Created: 2024-04-10T19:31:13.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-05-20T18:19:42.000Z (7 months ago)
- Last Synced: 2024-05-21T16:49:16.171Z (7 months ago)
- Topics: gitops, golang, refactoring
- Language: Go
- Homepage:
- Size: 204 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# saturn-bot 🪐🤖
Create, modify or delete files across many repositories in parallel.
## Use cases
- Onboard repositories to CI workflows.
- Keep files in sync across repositories.
- Automate code rewrites.
## Features
- Create or delete files.
- Insert, replace or delete lines in files.
- Filter which repositories to modify.
- Automatic creation of pull requests.
- Support for GitHub and GitLab.
- Implement custom logic and complex changes through plugins in Go and Python.
- Automatically merge pull requests if all checks have passed and all approvals have been given.
## Quickstart
Requirements:
- saturn-bot installed.
- An access token for GitHub or GitLab.
Create the file `hello-world.yaml`:
```yaml title="hello-world.yaml"
# yaml-language-server: $schema=https://saturn-bot.readthedocs.io/en/latest/schemas/task.schema.json
name: "saturn-bot Hello World"
prTitle: "saturn-bot Hello World"
prBody: |
saturn-bot Quickstart.
This pull request creates the file `hello-world.txt`.
# Filters tell saturn-bot which repositories to modify.
filters:
- filter: repository
params:
host: github.com
owner: wndhydrnt # Replace with your owner
name: saturn-bot-example # Replace with your repository
# Actions tell saturn-bot how to modify each repository.
actions:
- action: fileCreate
params:
content: "Hello World"
path: "hello-world.txt"
```
Run saturn-bot:
GitHub
```shell
SATURN_BOT_GITHUBTOKEN= saturn-bot run hello-world.yaml
```
GitLab
```shell
SATURN_BOT_GITLABTOKEN= saturn-bot run hello-world.yaml
```