getsops / getsops/sops

Update install instructions at `go.mozilla.org`

Open
#1,055 4 comments 6 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area/documentation
Dominant language
Go
Stars
23.1k
Forks
1.1k
Avg merge
1d 11h
Merged PRs (30d)
9

Description

The installation instructions at https://go.mozilla.org/sops states that SOPS installation should be performed using:

go get -u go.mozilla.org/sops/cmd/sops

The go get command has been deprecated for installing binaries (and can lead to dependency issues) so the correct installation command is now:

go install go.mozilla.org/sops/v3/cmd/sops@latest

or for a specific version:

go install go.mozilla.org/sops/v3/cmd/sops@v3.7.2

As an aside, it would be nice to reference this installation method in the README - for those of us with Go already installed, it's simpler than downloading the binary, creating sym-links and setting executable flags.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by checking the installation instructions at https://go.mozilla.org/sops and the repository README. Update the documented Go installation command to use the versioned go install form, including the specific-version example, and add the method to the README if appropriate. Done means the published instructions no longer recommend go get for installing SOPS.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.