Update API reference and Build/Publish workflows #904
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
Previously in build-test-publish, a step would commit an API reference to the wiki, for every commit. We have moved away from that practice, and that change broke this workflow. The simplest solution is to generate the Wiki page from the tag, as part of this workflow.
This was left behind during the pruning of uploading to GCS, and Carvel package refactor.
MirahImage approved these changes Nov 5, 2024
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.
Note to reviewers: remember to look at the commits in this PR and consider if they can be squashed
Note to contributors: remember to re-generate client set if there are any API changes
Summary Of Changes
Additional Context
The Build/Test/Publish job was commiting + pushing to the Wiki for every commit. During the re-work of that pipeline,
we stopped pushing to the Wiki for every commit. That unintentionally broke the API reference workflow. The job is green
because the commands succeed, but the outcome is not correct. The simplest solution is to generate the API reference
just before publishing to the Wiki, in the same job.