Add ability to publish family provider docs for provider-updoc workflow #134
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
This was referenced Sep 14, 2023
turkenf
force-pushed
the
update-provider-updoc
branch
from
3ab8104
to
6aee415
Compare
turkenf
changed the title
ulucinar
approved these changes
Sep 27, 2023
| go run github.com/upbound/uptest/cmd/updoc@${{ env.UPTEST_VERSION }} upload --docs-dir=./docs --name=${{ env.PROVIDER_NAME }} --version=${{ env.VER_MAJOR_MINOR }} --bucket-name=bucket-marketplace-docs-production --cdn-domain=https://user-content.upbound.io | ||
| for s in $SUBPACKAGES; do | ||
| PROVIDER_PACKAGE_NAME="${{ env.PROVIDER_NAME }}-$s" | ||
| DOCS_DIR="./docs/family" |
There was a problem hiding this comment.
nit: In a future iteration, we may rename the docs/family folders in the official provider repositories as docs/config because config is the name that we use internally for referring to the family's config package. This would further allow us to compute the docs folder from which to publish the docs as follows:
DOCS_DIR="./docs/${s}"This would also eliminate the conditionals in this block. It would also make it easy for us to publish specific docs for new resource providers (if this is needed in the future).
turkenf
force-pushed
the
update-provider-updoc
branch
from
2615255
to
e6464da
Compare
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.
Description of your changes
This PR adds the ability to publish family provider docs for
provider-updocworkflowI have:
make reviewable testto ensure this PR is ready for review.How has this code been tested
Manually tested on
turkenf/uptestandturkenf/provider-gcpResult of the upload docs step of the updoc workflow triggered in
turkenf/provider-gcp:Manual publishing for
provider-family-gcpv0.33.0 family provider: