Skip to content
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.

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

chore: add tools.go #310

Merged
merged 7 commits into from
Mar 2, 2023
Merged

chore: add tools.go #310

merged 7 commits into from
Mar 2, 2023

Conversation

aljo242
Copy link

@aljo242 aljo242 commented Feb 20, 2023

1. Summary

Adds a tools pkg which allows us to require development tools like golangci-lint and gofumpt in our go.mod file. This is potentially useful for new devs working with our code who may not have the tools installed. Otherwise, they would receive a make target fail if they tried to run something like make format without the tool installed.

This addition also lets us ensure that all developers are using the same minimum version for said tools.

2.Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)

3. Implementation details

  • add tools/tools.go
  • Use build tags to ensure these are not built into our binaries

4. How to test/use

  • run go clean -modcache and remove tools like gofumpt
  • run go mod tidy and then try to use tools again

ajansari95
ajansari95 previously approved these changes Feb 22, 2023
Copy link
Contributor

@ajansari95 ajansari95 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@codecov-commenter
Copy link

codecov-commenter commented Feb 24, 2023

Codecov Report

Merging #310 (6c2c0a7) into main (0635179) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #310   +/-   ##
=======================================
  Coverage   54.40%   54.40%           
=======================================
  Files         152      152           
  Lines       12042    12042           
=======================================
  Hits         6552     6552           
  Misses       5030     5030           
  Partials      460      460           
Flag Coverage Δ
unittests 54.40% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Copy link
Contributor

@joe-bowman joe-bowman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Copy link
Contributor

@ajansari95 ajansari95 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ajansari95 ajansari95 merged commit f8a8c24 into main Mar 2, 2023
@joe-bowman joe-bowman deleted the chore/tools branch March 11, 2023 02:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants