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: generate docs versions var #994

Merged
merged 1 commit into from
Jul 25, 2024

Conversation

rollandf
Copy link
Member

Generate documentation var files to be used
in network-operator-docs repo.

@rollandf rollandf added the on hold This enhancement is currently on hold pending additional clarification and evaluation label Jul 15, 2024
@coveralls
Copy link
Collaborator

coveralls commented Jul 15, 2024

Pull Request Test Coverage Report for Build 10090377988

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 7 unchanged lines in 2 files lost coverage.
  • Overall coverage increased (+0.2%) to 64.192%

Files with Coverage Reduction New Missed Lines %
controllers/macvlannetwork_controller.go 2 86.25%
controllers/ipoibnetwork_controller.go 5 77.38%
Totals Coverage Status
Change from base Build 10090262115: 0.2%
Covered Lines: 3268
Relevant Lines: 5091

💛 - Coveralls

@rollandf rollandf force-pushed the hack-docs-version branch 2 times, most recently from b2dcccd to 4e621f8 Compare July 22, 2024 14:48
@@ -136,6 +138,10 @@ func main() {
if *retrieveSha {
resolveImagesSha(&release)
}
parts := strings.Split(release.NetworkOperator.Version, ".")
release.OcpDefaulChannel = fmt.Sprintf("%s.%s", parts[0], parts[1])
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do we want to generate OCP channels list (e.g. stable,v24.4.1) too?

Copy link
Member Author

Choose a reason for hiding this comment

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

We use this one for OpenShift installation via CLI where we need a single channel, not a list:
image

Copy link
Collaborator

Choose a reason for hiding this comment

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

cant we always specify default here ? then install specific operator version ?

.PHONY: generate-docs-versions-var
generate-docs-versions-var:
cd hack && $(GO) run release.go --templateDir ./templates/docs-versions-var/ --outputDir .
mv hack/vars.yaml hack/vars.rst
Copy link
Collaborator

Choose a reason for hiding this comment

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

do we want to add hack/vars.rst to .gitignore?

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

@rollandf rollandf force-pushed the hack-docs-version branch from 4e621f8 to be5e1c4 Compare July 23, 2024 06:30
@rollandf rollandf removed the on hold This enhancement is currently on hold pending additional clarification and evaluation label Jul 23, 2024
@rollandf
Copy link
Member Author

/retest-image_scan

.gitignore Outdated
@@ -30,3 +30,5 @@ testbin
test
build
hack/manifests

hack/vars.rst
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: newline

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

@@ -77,3 +78,5 @@ rdmaCni:
image: rdma-cni
repository: ghcr.io/k8snetworkplumbingwg
version: v1.2.0
Nfd:
version: v0.13.2
Copy link
Collaborator

@adrianchiris adrianchiris Jul 25, 2024

Choose a reason for hiding this comment

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

nit: its v0.15.6 now

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

Generate documentation var files to be used
in network-operator-docs repo.

Signed-off-by: Fred Rolland <[email protected]>
@rollandf rollandf force-pushed the hack-docs-version branch from be5e1c4 to 2bc1d82 Compare July 25, 2024 08:01
@adrianchiris
Copy link
Collaborator

at some point, i think we would need to carve out docs related scripts/logic and put them in doc repo if we see we get too much of those, relying on release.yaml file from this repo.

@adrianchiris adrianchiris merged commit 403913e into Mellanox:master Jul 25, 2024
12 of 16 checks passed
@rollandf rollandf deleted the hack-docs-version branch August 27, 2024 08:55
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