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

Release support to 1.21.x #28

Merged
merged 4 commits into from
Dec 2, 2023
Merged

Release support to 1.21.x #28

merged 4 commits into from
Dec 2, 2023

Conversation

kairoaraujo
Copy link
Owner

  • Added tests in CI for testing the documentation changes not committed

    Closes Implement a better doc test #14

  • Add details for contributing to the project CONTRIBUTING.md

Signed-off-by: Kairo Araujo kairo@kairo.eti.br

go test -covermode=count -coverprofile=count.out -v ./...
go test -covermode=count -coverprofile=count.out -v $(go list ./... | grep -v /docs-test/)

export PATH=$$PATH:`go env GOPATH`/bin; make -C rest-api test-doc
Copy link
Collaborator

Choose a reason for hiding this comment

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

@kairoaraujo It looks like now that the test recipe eventually leads to a call to swag, the GitHub workflow is broken since the ubuntu-latest container shell environment can't find the swag command. See: https://github.com/kairoaraujo/goca/actions/runs/3142411740/jobs/5105977765

Which is confusing because it looks like the check_swag recipe which we depend on should handle this.
Checking the branch out and running the tests locally on my machine does indeed auto-magically download swag.
Perhaps it is something to do with how $PATH is handled in the ubuntu-latest container?

Copy link
Owner Author

Choose a reason for hiding this comment

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

Thank you @necheffa, I will find time to fix it this weekend :)

- Added tests in CI for testing the documentation changes not committed

  Closes #14

- Add details for contributing to the project CONTRIBUTING.md

- Update for latest go version and dependencies

Signed-off-by: Kairo de Araujo <kairo@kairo.eti.br>
Signed-off-by: Kairo de Araujo <kairo@dearaujo.nl>
Signed-off-by: Kairo de Araujo <kairo@dearaujo.nl>
@codecov-commenter
Copy link

codecov-commenter commented Nov 28, 2023

Codecov Report

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

Comparison is base (8e931bb) 65.94% compared to head (940c632) 56.08%.
Report is 24 commits behind head on main.

Files Patch % Lines
ca.go 65.09% 23 Missing and 14 partials ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #28      +/-   ##
==========================================
- Coverage   65.94%   56.08%   -9.86%     
==========================================
  Files           2        2              
  Lines         323      460     +137     
==========================================
+ Hits          213      258      +45     
- Misses         69      163      +94     
+ Partials       41       39       -2     

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

Signed-off-by: Kairo de Araujo <kairo@dearaujo.nl>
@kairoaraujo
Copy link
Owner Author

@necheffa,
"Better late than never"

I think due the changes, we should release as 2.0.0, WDYT?

@kairoaraujo kairoaraujo changed the title Add tests for documentation and contributing info Release support to 1.21.x Nov 28, 2023
@necheffa
Copy link
Collaborator

necheffa commented Dec 2, 2023

@kairoaraujo I think bumping to 2.0.0 makes sense. Looks like the API changed just a little. Should we then also add "v2" to the module path so that github.com/kairoaraujo/goca becomes github.com/kairoaraujo/goca/v2?

Copy link
Collaborator

@necheffa necheffa left a comment

Choose a reason for hiding this comment

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

LGTM

@necheffa necheffa merged commit 57c8b8d into main Dec 2, 2023
2 checks passed
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.

Implement a better doc test
3 participants