Attempt to fix api-docs generation #114
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
souleb
force-pushed
the
attempt-fix-api-docs
branch
2 times, most recently
from
14fbb04 to
40ec7fe
Compare
maze88
requested changes
Oct 8, 2024
.github/workflows/docs-ci.yaml
Outdated
| repository: ${{ github.repository_owner }}/network-operator-docs # repo must be explicitly set here for workflow calling to behave correctly | ||
| token: ${{ inputs.token || secrets.GH_TOKEN_NVIDIA_CI_CD }} # token must be explicitly set here for push to work in following step | ||
| - name: Setup Go | ||
| uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32 # v5.0.2 |
Collaborator
There was a problem hiding this comment.
Are the Make targets sensitive to the version of the Go action?
If not:
- Then the GitHub runner's workspace already has Go available, so this step is redundant.
If yes:
- Prefer to use an explicit tag (version) of the action rather than a commit hash...
- Furthermore, who is responsible to increment this specific version in the not-near future? perhaps there is a solution that could improve the Go code itself to be less version-sensitive?
Contributor
Author
There was a problem hiding this comment.
So the bug is related to make api-docs which rely on a go package. It run successfully locally with GO 1.22.7/8 and go 1.23. So my supposition is that it's related to the go installation. I hope that a fresh install can fix it.
Collaborator
There was a problem hiding this comment.
What about adding a dependency for the package (and its specific version) in the code?
Signed-off-by: Soule <souleb@nvidia.com>
souleb
force-pushed
the
attempt-fix-api-docs
branch
from
f63fa88 to
ec9ce8f
Compare
rollandf
approved these changes
Oct 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.