Skip to content

Various fixes #296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
smlx merged 4 commits into from
Aug 12, 2026
Merged

Various fixes #296

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0fcd4a8
chore: remove go report card badge from README
smlx Aug 10, 2026
33cf796
chore: make it clearer how to use for single binary
smlx Aug 10, 2026
ac41d44
chore: document removing image build support
smlx Aug 10, 2026
0b76453
chore: update setup instructions for internal/private repos
smlx Aug 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)

Expand Down Expand Up @@ -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:

Expand Down
Loading