Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ekristen/cloud-provider-zero
Cloud Provider Zero - Cloud Provider Goodness without the cruft
https://github.com/ekristen/cloud-provider-zero
Last synced: about 2 months ago
JSON representation
Cloud Provider Zero - Cloud Provider Goodness without the cruft
- Host: GitHub
- URL: https://github.com/ekristen/cloud-provider-zero
- Owner: ekristen
- License: mit
- Created: 2023-08-25T19:25:06.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-31T13:38:43.000Z (2 months ago)
- Last Synced: 2024-10-31T14:35:25.842Z (2 months ago)
- Language: Go
- Size: 28.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Go Project Template
This is an opinionated go project template to use as a starting point for new projects.
## Features
- Builds with [GoReleaser](https://goreleaser.com)
- Automated with GitHub Actions
- Signed with Cosign (providing you generate a private key)
- Linting with [golangci-lint](https://golangci-lint.run/)
- Automated with GitHub Actions
- Builds with Docker
- While designed to use goreleaser, you can still just run `docker build`
- Opinionated Layout
- Never use `internal/` folder
- Everything is under `pkg/` folder
- Automatic Dependency Management with [Renovate](https://github.com/renovatebot/renovate)
- Automatic Releases with [Release Drafter](https://github.com/release-drafter/release-drafter)
- Documentation with Material for MkDocs
- API Server Example
- Uses Gorilla Mux (yes it's been archived, still the best option)
- Stubbed out Go Tests
- They are not comprehensive
### Opinionated Decisions
- Uses `init` functions for registering commands globally.
- This allows for multiple `main` package files to be written and include different commands.
- Allows the command code to remain isolated from each other and a simple import to include the command.
## Building
The following will build binaries in snapshot order.
```console
goreleaser --clean --snapshot
```
## Configure
1. Rename Repository
2. Generate Cosign Keys
3. Update `.goreleaser.yml`, search/replace go-project-template with new project name, adjust GitHub owner
4. Update `main.go`,
5. Update `go.mod`, rename go project (using IDE is best so renames happen across all files)
### Signing
1. Create a password
- Recommend exporting in environment as `COSIGN_PASSWORD` using something like [direnv](http://direnv.net)
2. Generate cosign keys `cosign generate-key-pair`
3. Create GitHub Action Secrets
- `COSIGN_KEY` -> populate with cosign.key value
- `COSIGN_PASSWORD` -> populate with password from step 1
### Releases
In order for Release Drafter and GoReleaser to work properly you have to create a PAT to run Release Drafter
so it's actions against the repository can trigger other workflows. Unfortunately there is no way to trigger
a workflow from a workflow if both are run by the automatically generated GitHub Actions secret.
1. Create PAT that has write contents permissions to the repository
2. Create GitHub Action Secret
- `RELEASE_DRAFTER_SECRET` -> populated with PAT from step 1
3. Done
## Documentation
The project is built to have the documentation right alongside the code in the `docs/` directory leveraging Mkdocs Material.
In the root of the project exists mkdocs.yml which drives the configuration for the documentation.
This README.md is currently copied to `docs/index.md` and the documentation is automatically published to the GitHub
pages location for this repository using a GitHub Action workflow. It does not use the `gh-pages` branch.
### Running Locally
```console
make docs-serve
```
OR (if you have docker)
```console
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
```