Skip to content

chore: relint & update#269

Merged
casualjim merged 1 commit intogo-openapi:masterfrom
fredbi:chore/update-linting
Dec 8, 2023
Merged

chore: relint & update#269
casualjim merged 1 commit intogo-openapi:masterfrom
fredbi:chore/update-linting

Conversation

@fredbi
Copy link
Member

@fredbi fredbi commented Dec 7, 2023

  • updated go version requirement to go1.19

  • updated dependencies, excepted:

    • yaml (upgrade to v3 deferred to another PR)
    • otel (upgrade is breaking: deferred to another PR)

  • ci: updated linting rules, in line with other go-openapi repos

    • exception: disabled the "nilerr" linter, which currently crashes for this repo

  • ci:updated github actions, in line with other go-openapi repos

  • doc: updated README links and badges

  • major relinting of all test code

  • relinting non-test code is deferred to another PR (hopefully with less changes)

  • changes to non-test code are limited to:

    • addition of (temporary) nolint directives
    • gofmt/typos in comments
    • unused params

TODO in forthcoming PRs:

  • upgrade to yaml/v3
  • upgrade OTEL packages
  • gradually remove most "nolint" directives in non-test code
  • complete test refactoring: some nolint directives have been added to skip more complex refacoring (e.g. duplicate code)

@fredbi
chore: relint & update
e4cc157 
* updated go version requirement to go1.19
* updated dependencies, excepted:
   * yaml (upgrade to v3 deferred to another PR)
   * otel (upgrade is breaking: deferred to another PR)

* ci: updated linting rules, in line with other go-openapi repos
   * exception: disabled the "nilerr" linter, which currently crashes for
     this repo
* ci:updated github actions, in line with other go-openapi repos
* doc: updated README links and badges

* major relinting of all test code
* relinting non-test code is deferred to another PR (hopefully with less changes)
* changes to non-test code are limited to:
  * addition of (temporary) nolint directives
  * gofmt/typos in comments
  * unused params

TODO in forthcoming PRs:
* [ ] upgrade to yaml/v3
* [ ] upgrade OTEL packages
* [ ] gradually remove most "nolint" directives in non-test code
* [ ] complete test refactoring: some nolint directives have been added
      to skip more complex refacoring (e.g. duplicate code)

Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
@codecov
Copy link

codecov bot commented Dec 7, 2023 •
edited
Loading

Codecov Report

Attention: 3 lines in your changes are missing coverage. Please review.

Comparison is base (1ade6d4) 80.26% compared to head (e4cc157) 80.26%.

Files Patch % Lines
client/request.go 80.00% 1 Missing ⚠️
client/runtime.go 80.00% 1 Missing ⚠️
middleware/context.go 80.00% 0 Missing and 1 partial ⚠️
Additional details and impacted files 
@@           Coverage Diff           @@
##           master     #269   +/-   ##
=======================================
  Coverage   80.26%   80.26%           
=======================================
  Files          44       44           
  Lines        3350     3350           
=======================================
  Hits         2689     2689           
  Misses        546      546           
  Partials      115      115
Flag Coverage Δ
oldstable 80.26% <92.50%> (?)
stable 80.26% <92.50%> (?)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@fredbi fredbi requested review from casualjim and youyuanwu December 7, 2023 12:08
@fredbi
Copy link
Member Author

fredbi commented Dec 7, 2023 •
edited
Loading

NOTE to reviewers

Ok so this one is huge. Apologies... That's because this PR has long been overdue...

To simplify a bit the review process, I've not addressed (yet) linting issues in non-testing code other
than adding nolint directives. So go files which are not test programs should normally only differ in their comments, or changes that can be verified at build time (e.g. unused parameter declaration, gofmt).

Hopefully this PR makes more readable to contributors the huge work that has been accumulated to test thoroughly this package.

@fredbi
Copy link
Member Author

fredbi commented Dec 7, 2023

Status of the above-mentioned forthcoming PRs:

@casualjim casualjim merged commit 381952b into go-openapi:master Dec 8, 2023
@fredbi fredbi deleted the chore/update-linting branch December 8, 2023 08:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@casualjim casualjim casualjim approved these changes

@youyuanwu youyuanwu Awaiting requested review from youyuanwu

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@fredbi @casualjim