From 0fcd4a8e0f98c76b8b0270b2259f11cee227ab76 Mon Sep 17 00:00:00 2001 From: Scott Leggett Date: Mon, 10 Aug 2026 23:22:23 +0800 Subject: [PATCH 1/4] chore: remove go report card badge from README GRC is retired --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 54ead71..5984177 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,6 @@ [![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) [![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) From 33cf7962f194797a4e158bf852c9720f92b91e98 Mon Sep 17 00:00:00 2001 From: Scott Leggett Date: Mon, 10 Aug 2026 23:24:24 +0800 Subject: [PATCH 2/4] chore: make it clearer how to use for single binary --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 5984177..5b3c279 100644 --- a/README.md +++ b/README.md @@ -59,8 +59,11 @@ Then customize the code for your repository: 1. Update the code for your project: * rename `cmd/go-cli-github` to `cmd/$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` * 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`) From ac41d44b23d00057f9a44a858cad11249290e2b1 Mon Sep 17 00:00:00 2001 From: Scott Leggett Date: Mon, 10 Aug 2026 23:27:24 +0800 Subject: [PATCH 3/4] chore: document removing image build support --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 5b3c279..14fc165 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,11 @@ Then customize the code for your repository: * 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`) From 0b76453e9e895ca9c9a01be8b200b6acb21ae1c5 Mon Sep 17 00:00:00 2001 From: Scott Leggett Date: Wed, 12 Aug 2026 11:59:01 +0800 Subject: [PATCH 4/4] chore: update setup instructions for internal/private repos --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 14fc165..6b4e951 100644 --- a/README.md +++ b/README.md @@ -1,7 +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 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,7 +60,7 @@ Then customize the code for your repository: * rename `cmd/go-cli-github` to `cmd/$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`. + * 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` @@ -72,6 +72,9 @@ Then customize the code for your repository: * 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: