Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ashishb/gabo
GitHub Actions Boilerplate Generator
https://github.com/ashishb/gabo
automation devops github githubactions golang
Last synced: about 22 hours ago
JSON representation
GitHub Actions Boilerplate Generator
- Host: GitHub
- URL: https://github.com/ashishb/gabo
- Owner: ashishb
- License: apache-2.0
- Created: 2023-03-27T04:45:08.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-11-05T19:11:22.000Z (8 days ago)
- Last Synced: 2024-11-05T19:43:42.066Z (8 days ago)
- Topics: automation, devops, github, githubactions, golang
- Language: Go
- Homepage: https://ashishb.net/tech/common-pitfalls-of-github-actions/
- Size: 173 KB
- Stars: 98
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - ashishb/gabo - GitHub Actions Boilerplate Generator (Go)
README
# GitHub Actions Boilerplate (`gabo`)
[](https://github.com/ashishb/gabo/actions/workflows/lint-yaml.yaml) [](https://github.com/ashishb/gabo/actions/workflows/lint-markdown.yaml)
[](https://github.com/ashishb/gabo/actions/workflows/lint-go.yaml) [](https://github.com/ashishb/gabo/actions/workflows/format-go.yaml) [](https://github.com/ashishb/gabo/actions/workflows/test-go.yaml)
[](https://github.com/ashishb/gabo/actions/workflows/check-goreleaser-config.yaml)
[](https://github.com/ashishb/gabo/actions/workflows/release-binary.yaml) [](https://goreportcard.com/report/github.com/ashishb/gabo/src/gabo)
**gabo** short for GitHub Actions Boilerplate is for ease-of-generation of GitHub actions boilerplate with good timeouts, path filters, and concurrency preventions. See [this blogpost](https://ashishb.net/tech/common-pitfalls-of-github-actions/) for more details on why the GitHub defaults aren't great.
The actions runs only on push/pull requests against `main` and `master` branch, by default.
Feel free to add more branches if you want to runs these checks when push/pull request against any other branches.
## Installation
```bash
$ go install github.com/ashishb/gabo/src/gabo/cmd/gabo@latest
...
```
or via homebrew 
```bash
$ brew install gabo
...
```
Or run directly
```bash
# --dir flag is optional and defaults to current directory
go run github.com/ashishb/gabo/src/gabo/cmd/gabo@latest --dir=
```
## Usage
```bash
$ gabo --help
Usage of gabo:
-dir string
Path to root of git directory (default ".")
-for string
Generate GitHub Action (options: build-android,lint-android,translate-android,compress-images,build-docker,build-npm,build-yarn,lint-docker,format-go,lint-go,check-go-releaser,lint-html,lint-markdown,validate-openapi-schema,format-python,lint-python,lint-shell-script,lint-solidity,lint-yaml,validate-render-blueprint)
-force
Force overwrite existing files (in generate mode)
-mode string
Mode to operate in: [generate analyze] (default "analyze")
-verbose
Enable verbose logging
-version
Prints version of the binary
```
### Sample usage - analyze a repository
```bash
# Analyze current directory (it should be the root of the repository)
$ gabo
# Analyze a different dir
$ gabo --dir=~/src/repo1
```
### Sample usage - generate code
```bash
$ gabo --mode=generate --for=lint-docker
Wrote file .github/workflows/lint-docker.yaml
```
### Supported actions
- [x] build-android
- [x] build-docker
- [x] check-go-releaser
- [x] compress-images
- [x] format-go
- [x] format-python
- [x] lint-android
- [x] lint-docker
- [x] lint-go
- [x] lint-html
- [x] lint-markdown
- [x] lint-python
- [x] lint-shell-script
- [x] lint-solidity
- [x] lint-yaml
- [x] translate-android
- [x] validate-openapi-schema
- [x] validate-render-blueprint
- [ ] build-rust
- [ ] lint-rust