-
Notifications
You must be signed in to change notification settings - Fork 334
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
GA: Publish v1 docs for GitRepository, Receiver & Kustomization #1427
Merged
Conversation
This file contains 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
makkes
force-pushed
the
rcv-v1
branch
5 times, most recently
from
March 23, 2023 16:04
818be4e
to
d068deb
Compare
It looks great! Thanks @makkes I've put this on hold until we release NC, then you can switch back to semver in the script. |
stefanprodan
changed the title
GA: adapt to n-c Receiver API graduating to v1
GA: Publish v1 docs for GitRepository & Receiver
Mar 28, 2023
makkes
changed the title
GA: Publish v1 docs for GitRepository & Receiver
GA: Publish v1 docs for GitRepository, Receiver & Kustomization
Mar 30, 2023
makkes
pushed a commit
to fluxcd/notification-controller
that referenced
this pull request
Mar 30, 2023
This commit bumps the Receiver API version to v1 in preparation of the Flux GitOps GA milestone (https://fluxcd.io/roadmap/#flux-gitops-ga-q1-2023). We are now actively maintaining two versions of the notification API group in parallel: v1 which currently only holds the Receiver kind and v1beta2 for all other kinds. Since we haven't run into this situation before, I had to change the way we expose the API docs in ./docs/api: The directory now has sub-directories for each active API version. Therefore we need to change our scripts in the website repository to take this change into account so that we expose both API group version at https://fluxcd.io/flux/components/notification/api/. This change is implemented in fluxcd/website#1427. refs #436 Signed-off-by: Max Jonas Werner <[email protected]>
alekspog
pushed a commit
to alekspog/notification-controller
that referenced
this pull request
Mar 30, 2023
This commit bumps the Receiver API version to v1 in preparation of the Flux GitOps GA milestone (https://fluxcd.io/roadmap/#flux-gitops-ga-q1-2023). We are now actively maintaining two versions of the notification API group in parallel: v1 which currently only holds the Receiver kind and v1beta2 for all other kinds. Since we haven't run into this situation before, I had to change the way we expose the API docs in ./docs/api: The directory now has sub-directories for each active API version. Therefore we need to change our scripts in the website repository to take this change into account so that we expose both API group version at https://fluxcd.io/flux/components/notification/api/. This change is implemented in fluxcd/website#1427. refs fluxcd#436 Signed-off-by: Max Jonas Werner <[email protected]>
15 tasks
makkes
pushed a commit
that referenced
this pull request
Apr 3, 2023
We changed the directory structure of the specs in the respective controllers' v1 versions. Until a full Flux release has been cut we need to exclude all v1 versions from being imported until #1427 has landed. Signed-off-by: Max Jonas Werner <[email protected]>
makkes
force-pushed
the
rcv-v1
branch
3 times, most recently
from
April 5, 2023 12:07
c0db154
to
819539d
Compare
The following API types have been graduated to v1: - NC Receiver - KC Kustomization - SC GitRepository In addition to that we want the API navigation entries to appear at the bottom of the tree. To accomplish that the import script is now able to parse a weight parameter from imported markdown specs and put it into the front matter of the resulting file. refs fluxcd/notification-controller#436 Signed-off-by: Max Jonas Werner <[email protected]>
- GitRepository v1 - Kustomization v1 - Receiver v1 - CronJob v1 Signed-off-by: Max Jonas Werner <[email protected]>
Signed-off-by: Max Jonas Werner <[email protected]>
refs fluxcd/flux2#3731 Signed-off-by: Max Jonas Werner <[email protected]>
stefanprodan
approved these changes
Apr 6, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Thanks @makkes 🥇
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changes:
weight
comments for proper ordering of pages