diff --git a/README.md b/README.md index 54ead71..6b4e951 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,7 @@ # Go CLI GitHub -[![Go Reference](https://pkg.go.dev/badge/github.com/smlx/go-cli-github.svg)](https://pkg.go.dev/github.com/smlx/go-cli-github) [![Release](https://github.com/smlx/go-cli-github/actions/workflows/release.yaml/badge.svg)](https://github.com/smlx/go-cli-github/actions/workflows/release.yaml) -[![Go Report Card](https://goreportcard.com/badge/github.com/smlx/go-cli-github)](https://goreportcard.com/report/github.com/smlx/go-cli-github) +[![Go Reference](https://pkg.go.dev/badge/github.com/smlx/go-cli-github.svg)](https://pkg.go.dev/github.com/smlx/go-cli-github) [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/smlx/go-cli-github/badge)](https://securityscorecards.dev/viewer/?uri=github.com/smlx/go-cli-github) [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8168/badge)](https://www.bestpractices.dev/projects/8168) @@ -60,11 +59,22 @@ Then customize the code for your repository: 1. Update the code for your project: * rename `cmd/go-cli-github` to `cmd/$YOUR_COMMAND` - * update `.github/workflows/build.yaml`, replacing `go-cli-github` with `$YOUR_COMMAND`. + * if you only have one binary: `rm -rf cmd/another-binary` + * update `.github/workflows/build.yaml`, replacing `go-cli-github` with `$YOUR_COMMAND` + * if you only have one binary: delete references to `another-binary` * update `.goreleaser.yaml` to build `cmd/$YOUR_COMMAND` + * if you only have one binary: delete the YAML anchor and references to `another-binary` + * if you don't need docker images: + 1. edit `.goreleaser.yaml` and delete `dockers_v2` + 1. edit `.github/workflows/build.yaml` and delete the `build-image` job. + 1. edit `.github/workflows/release.yaml` and delete the ghcr login, and image attestation steps. + 1. delete `Dockerfile` * update the links at the top of `README.md` * update the contact email in `SECURITY.md` * if you aren't [in an enterprise that has code quality enabled](https://github.com/orgs/community/discussions/194833#discussioncomment-17174472), delete the coverage workflow (`.github/workflows/coverage.yaml`) + * if your repository is not public (i.e. internal or private) + 1. delete the OSSF workflow (`.github/workflows/ossf-analysis.yaml`) + 1. remove the OSSF and Go Reference badges from the top of the `README.md` 1. Commit and push: