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

Update Example Readme Manifest Links #235

Closed
danehans opened this issue Jan 28, 2025 · 3 comments
Closed

Update Example Readme Manifest Links #235

danehans opened this issue Jan 28, 2025 · 3 comments

Comments

@danehans
Copy link
Contributor

#233 updated example readme manifest links to use a raw URL. While this approach works well for versioning the links, testing new links is difficult and error-prone. I suggest reverting the links and using a script (with a make target) to convert the links to raw URLs. The make target can then be called when cutting a release to convert the paths to raw URLs.

@danehans
Copy link
Contributor Author

Note that the step for installing the CRDs is still path-based:

kubectl apply -k https://github.com/kubernetes-sigs/gateway-api-inference-extension/config/crd

To support a release-based install, this step will need to reference a release artifact or add a script (with a make target) that combines the CRDs into a single yaml file with --- separator for each manifest.

Artifact example:

kubectl apply -f https://github.com/kubernetes-sigs/gateway-api-inference-extension/releases/download/v0.0.1/install.yaml

Combined example (after running make target):

kubectl apply -f https://github.com/kubernetes-sigs/gateway-api-inference-extension/raw/main/config/crd/install.yaml

@ahg-g this should be considered for v0.1.

@kfswain
Copy link
Collaborator

kfswain commented Jan 28, 2025

We can just kustomize build config/crd -o wherever/you/want.yaml which will do what you describe, and that is what we intend to use for our release artifacts. We can update a make target for that , otherwise theres a refactor/validation of the makefile modifications, which seems more work, and breaks the pattern of prior art that many other projects use.

When we have release artifacts we can update, and so this cannot block v0.1

@danehans
Copy link
Contributor Author

Fixed by #221 and #233

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

No branches or pull requests

2 participants