Skip to content

Commit

Permalink
Contributing guide (and related) clean up (#3538)
Browse files Browse the repository at this point in the history
  • Loading branch information
thampiotr committed Apr 13, 2023
1 parent 345d7d8 commit 54970a2
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 14 deletions.
6 changes: 0 additions & 6 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,7 +1 @@
pkg/operator/crds/*.yaml linguist-generated=true

# Git on Windows may automatically check out files with crlf line endings,
# which breaks the Fuzz parser in 1.18 (golang/go#52268). A fix is scheduled
# for 1.19, but in the meantime we have to disable autocrlf for Fuzz files and
# ensure that \n is the only end-of-line character used.
**/testdata/fuzz/Fuzz*/** -text eol=lf
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Build, test, and generate code for various parts of Grafana Agent.
##
## At least Go 1.18, git, and a moderately recent version of Docker is required
## At least Go 1.19, git, and a moderately recent version of Docker is required
## to be able to use the Makefile. This list isn't exhaustive and there are other
## dependencies for the generate-* targets. If you do not have the full list of
## build dependencies, you may set USE_CONTAINER=1 to proxy build commands to a
Expand Down
9 changes: 4 additions & 5 deletions docs/developer/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ down the issues involving the components you want to work on.
To build Grafana Agent from source code, please install the following tools:

1. [Git](https://git-scm.com/)
2. [Go](https://golang.org/) (version 1.18 and up)
2. [Go](https://golang.org/) (version 1.19 and up)
3. [Make](https://www.gnu.org/software/make/)
4. [Docker](https://www.docker.com/)

Expand Down Expand Up @@ -163,17 +163,16 @@ To add or update a new dependency, use the `go get` command:

```bash
# Pick the latest tagged release.
go install example.com/some/module/pkg@latest
go get example.com/some/module/pkg@latest

# Pick a specific version.
go install example.com/some/module/pkg@vX.Y.Z
go get example.com/some/module/pkg@vX.Y.Z
```

Tidy up the `go.mod` and `go.sum` files:

```bash
# The GO111MODULE variable can be omitted when the code isn't located in GOPATH.
GO111MODULE=on go mod tidy
go mod tidy
```

You have to commit the changes to `go.mod` and `go.sum` before submitting the
Expand Down
2 changes: 0 additions & 2 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -1855,8 +1855,6 @@ github.com/grafana/phlare/api v0.1.2 h1:1jrwd3KnsXMzj/tJih9likx5EvbY3pbvLbDqAAYe
github.com/grafana/phlare/api v0.1.2/go.mod h1:29vcLwFDmZBDce2jwFIMtzvof7fzPadT8VMKw9ks7FU=
github.com/grafana/postgres_exporter v0.8.1-0.20210722175051-db35d7c2f520 h1:HnFWqxhoSF3WC7sKAdMZ+SRXvHLVZlZ3sbQjuUlTqkw=
github.com/grafana/postgres_exporter v0.8.1-0.20210722175051-db35d7c2f520/go.mod h1:+HPXgiOV0InDHcZ2jNijL1SOKvo0eEPege5fQA0+ICI=
github.com/grafana/process-exporter v0.7.3-0.20210106202358-831154072e2a h1:JUnP/laSl2GylHT0+fqAqOZY+7XkLh1mLefLN0n8Mmk=
github.com/grafana/process-exporter v0.7.3-0.20210106202358-831154072e2a/go.mod h1:RMjrx3Qn8l2pgCD27g45xbko4UDpVVuHC8Cd2YXPtWA=
github.com/grafana/prometheus v1.8.2-0.20230328154716-1d0e5416a0de h1:HjEfLfBCMlZktx4tGEtMSbTZNdHrhzaCouRsXkh13ps=
github.com/grafana/prometheus v1.8.2-0.20230328154716-1d0e5416a0de/go.mod h1:Pfqb/MLnnR2KK+0vchiaH39jXxvLMBk+3lnIGP4N7Vk=
github.com/grafana/regexp v0.0.0-20221122212121-6b5c0a4cb7fd h1:PpuIBO5P3e9hpqBD0O/HjhShYuM6XE0i/lbE6J94kww=
Expand Down

0 comments on commit 54970a2

Please sign in to comment.