Skip to content

chore: use golangci lint#986

Merged
qweeah merged 1 commit into
oras-project:mainfrom
kranurag7:golangci
Jul 13, 2023
Merged

chore: use golangci lint#986
qweeah merged 1 commit into
oras-project:mainfrom
kranurag7:golangci

Conversation

@kranurag7

@kranurag7 kranurag7 commented Jun 23, 2023

Copy link
Copy Markdown
Contributor

What this PR does / why we need it:
The following are the places that's giving some errors as of now according to the linter.

output of running golangci locally 

$ golangci-lint run
cmd/oras/root/attach.go:94:22: Error return value of `cmd.MarkFlagRequired` is not checked (errcheck)
        cmd.MarkFlagRequired("artifact-type")
                            ^
cmd/oras/root/discover.go:191:13: Error return value is not checked (errcheck)
                        printJSON(ref)
                                 ^
cmd/oras/internal/display/print.go:119:9: Error return value is not checked (errcheck)
                        Print("Tagging", ref)
                             ^
cmd/oras/internal/display/print.go:139:9: Error return value is not checked (errcheck)
                        Print("Tagging", ref)
                             ^
cmd/oras/internal/option/packer_test.go:73:14: Error return value of `os.WriteFile` is not checked (errcheck)
        os.WriteFile(testFile, []byte(testContent), fs.ModePerm)
                    ^
cmd/oras/internal/option/remote.go:276:30: Error return value of `repo.SetReferrersCapability` is not checked (errcheck)
                repo.SetReferrersCapability(*opts.distributionSpec.referrersAPI)
                                           ^
cmd/oras/internal/option/remote_test.go:54:29: Error return value of `(*encoding/json.Encoder).Encode` is not checked (errcheck)
                        json.NewEncoder(w).Encode(testTagList)
                                                 ^
cmd/oras/internal/option/remote_test.go:236:28: Error return value of `(*encoding/json.Encoder).Encode` is not checked (errcheck)
                json.NewEncoder(w).Encode(testTagList)
                                         ^
internal/cache/target_test.go:180:12: Error return value of `w.Write` is not checked (errcheck)
                                w.Write(blob)
                                       ^
internal/graph/graph_test.go:142:14: Error return value of `memory.Push` is not checked (errcheck)
                memory.Push(ctx, descs[i], bytes.NewReader(blobs[i]))
                           ^
internal/graph/graph_test.go:258:14: Error return value of `memory.Push` is not checked (errcheck)
                memory.Push(ctx, descs[i], bytes.NewReader(blobs[i]))
                           ^
internal/graph/graph_test.go:356:14: Error return value of `memory.Push` is not checked (errcheck)
                memory.Push(ctx, descs[i], bytes.NewReader(blobs[i]))

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #981

Please check the following list:

  • Does the affected code have corresponding tests, e.g. unit test, E2E test?
  • Does this change require a documentation update?
  • Does this introduce breaking changes that would require an announcement or bumping the major version?
  • Do all new files have an appropriate license header?

@codecov-commenter

codecov-commenter commented Jun 25, 2023

Copy link
Copy Markdown

Codecov Report

Merging #986 (cba6d7a) into main (bf33bb7) will not change coverage.
The diff coverage is n/a.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

@@           Coverage Diff           @@
##             main     #986   +/-   ##
=======================================
  Coverage   81.26%   81.26%           
=======================================
  Files          53       53           
  Lines        2776     2776           
=======================================
  Hits         2256     2256           
  Misses        352      352           
  Partials      168      168

@shizhMSFT shizhMSFT changed the title use golangci lint chore: use golangci lint Jun 28, 2023
qweeah
qweeah requested changes Jun 29, 2023
View reviewed changes

@qweeah qweeah left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested to align with other actions.

Also this PR requires fixing of all detected issues otherwise the PR check will fail. @kranurag7 Do you want to do the fixing? If not have time I can add another PR to fix all the lint issues found.

Comment thread .github/workflows/golangci-lint.yml Outdated
Comment thread .github/workflows/golangci-lint.yml
@kranurag7 kranurag7 mentioned this pull request Jul 4, 2023
Merged
4 tasks
@qweeah

qweeah commented Jul 12, 2023

Copy link
Copy Markdown
Contributor

@kranurag7 Can you add signoff as is suggested in https://github.com/oras-project/oras/pull/986/checks?check_run_id=14956872091:

  • In your local branch, run: git rebase HEAD~3 --signoff
  • Force push your changes to overwrite the branch: git push --force-with-lease origin golangci

@TerryHowe

TerryHowe commented Jul 12, 2023

Copy link
Copy Markdown
Member

I just rebased, so you are going to have to git pull and take care of DCO

@kranurag7
use golangci-lint
b57da4b 
Signed-off-by: Anurag <contact.anurag7@gmail.com>
TerryHowe
TerryHowe approved these changes Jul 12, 2023
View reviewed changes

@TerryHowe TerryHowe left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

/lgtm

qweeah
qweeah approved these changes Jul 13, 2023
View reviewed changes

@qweeah qweeah left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@qweeah qweeah merged commit 3092656 into oras-project:main Jul 13, 2023
@kranurag7 kranurag7 deleted the golangci branch July 13, 2023 08:55
@qweeah qweeah mentioned this pull request Jul 21, 2023
Closed
qweeah pushed a commit to qweeah/oras that referenced this pull request Jul 21, 2023
@kranurag7 @qweeah
chore: use golangci lint (oras-project#986)
bbce8ac 
Signed-off-by: Anurag <contact.anurag7@gmail.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
qweeah pushed a commit to qweeah/oras that referenced this pull request Jul 21, 2023
@kranurag7 @qweeah
chore: use golangci lint (oras-project#986)
0aeb770 
Signed-off-by: Anurag <contact.anurag7@gmail.com>
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
shizhMSFT pushed a commit to shizhMSFT/oras that referenced this pull request Aug 3, 2023
@kranurag7 @shizhMSFT
chore: use golangci lint (oras-project#986)
663f13c 
Signed-off-by: Anurag <contact.anurag7@gmail.com>
@ZhongRuoyu ZhongRuoyu mentioned this pull request Aug 7, 2023
Merged
This was referenced Aug 24, 2023
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@TerryHowe TerryHowe TerryHowe approved these changes

@qweeah qweeah qweeah approved these changes

@sajayantony sajayantony Awaiting requested review from sajayantony sajayantony is a code owner

@shizhMSFT shizhMSFT Awaiting requested review from shizhMSFT shizhMSFT is a code owner

@SteveLasker SteveLasker Awaiting requested review from SteveLasker

Assignees

@qweeah qweeah

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

add Github actions to lint go code

4 participants

@kranurag7 @codecov-commenter @qweeah @TerryHowe