Update publish-docs to use a deploy_key #392
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
nhlien93
approved these changes
Sep 9, 2021
mothslaw
approved these changes
Sep 10, 2021
ankursarin
added a commit
to ankursarin/virtualization-sdk
that referenced
this pull request
Sep 13, 2021
ankursarin
added a commit
to ankursarin/virtualization-sdk
that referenced
this pull request
Sep 14, 2021
ankursarin
added a commit
that referenced
this pull request
Sep 14, 2021
mrburke
pushed a commit
that referenced
this pull request
Jan 12, 2022
* DOC-1074 Document password vault support for VSDK plugins (#347) * Correct Typo in Example, it should be UNIX not WINDOWS (#360) * Add documentation for gRPC message and memory limits #390 (#391) * Fix version number in doc header (#358) (#397) * Update Delphix Engine version required to 6.0.7.0. (#386) (#398) * Update SDK Docs deployment to use a deploy_key (#392) (#399) * CP-6005 Ensure vSDK test coverage (#403) * CP-6006 Futurize vSDK - Stage 1 (#404) * Add support for virtualCleanup decorator (#400) (#405) Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> * Fixes #401 Networking capabilities should be documented (#402) Fixes #401 Networking capabilities should be documented * CP-6009 Add to_str and to_byte helpers (#407) * CP-6621 bump sdk version to 4.0.0 (#409) * CP-6694 Update docs for SDK 4.0.0 (#410) * CP-7022 vSDK 4.0.0 release tasks * Update VirtualDelete flow diagram to include the virtual.cleanup call. (#414) Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> * Update documentation with new gRPC message limits (#415) Co-authored-by: Raul Santelices <rasantel@users.noreply.github.com> Co-authored-by: Ranzo J Taylor, III <36489926+Ranzo3@users.noreply.github.com> Co-authored-by: Jeff Ngo <35587243+jeffngo@users.noreply.github.com> Co-authored-by: Ankur <ankursarin@gmail.com> Co-authored-by: kurthdelphix <89274759+kurthdelphix@users.noreply.github.com> Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> Co-authored-by: Tom Walsh <61519496+mothslaw@users.noreply.github.com>
mrburke
pushed a commit
to mrburke/virtualization-sdk
that referenced
this pull request
Jan 13, 2022
* DOC-1074 Document password vault support for VSDK plugins (delphix#347) * Correct Typo in Example, it should be UNIX not WINDOWS (delphix#360) * Add documentation for gRPC message and memory limits delphix#390 (delphix#391) * Fix version number in doc header (delphix#358) (delphix#397) * Update Delphix Engine version required to 6.0.7.0. (delphix#386) (delphix#398) * Update SDK Docs deployment to use a deploy_key (delphix#392) (delphix#399) * CP-6005 Ensure vSDK test coverage (delphix#403) * CP-6006 Futurize vSDK - Stage 1 (delphix#404) * Add support for virtualCleanup decorator (delphix#400) (delphix#405) Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> * Fixes delphix#401 Networking capabilities should be documented (delphix#402) Fixes delphix#401 Networking capabilities should be documented * CP-6009 Add to_str and to_byte helpers (delphix#407) * CP-6621 bump sdk version to 4.0.0 (delphix#409) * CP-6694 Update docs for SDK 4.0.0 (delphix#410) * CP-7022 vSDK 4.0.0 release tasks * Update VirtualDelete flow diagram to include the virtual.cleanup call. (delphix#414) Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> * Update documentation with new gRPC message limits (delphix#415) Co-authored-by: Raul Santelices <rasantel@users.noreply.github.com> Co-authored-by: Ranzo J Taylor, III <36489926+Ranzo3@users.noreply.github.com> Co-authored-by: Jeff Ngo <35587243+jeffngo@users.noreply.github.com> Co-authored-by: Ankur <ankursarin@gmail.com> Co-authored-by: kurthdelphix <89274759+kurthdelphix@users.noreply.github.com> Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> Co-authored-by: Tom Walsh <61519496+mothslaw@users.noreply.github.com>
mrburke
pushed a commit
that referenced
this pull request
Jan 13, 2022
* DOC-1074 Document password vault support for VSDK plugins (#347) * Correct Typo in Example, it should be UNIX not WINDOWS (#360) * Add documentation for gRPC message and memory limits #390 (#391) * Fix version number in doc header (#358) (#397) * Update Delphix Engine version required to 6.0.7.0. (#386) (#398) * Update SDK Docs deployment to use a deploy_key (#392) (#399) * CP-6005 Ensure vSDK test coverage (#403) * CP-6006 Futurize vSDK - Stage 1 (#404) * Add support for virtualCleanup decorator (#400) (#405) Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> * Fixes #401 Networking capabilities should be documented (#402) Fixes #401 Networking capabilities should be documented * CP-6009 Add to_str and to_byte helpers (#407) * CP-6621 bump sdk version to 4.0.0 (#409) * CP-6694 Update docs for SDK 4.0.0 (#410) * CP-7022 vSDK 4.0.0 release tasks * Update VirtualDelete flow diagram to include the virtual.cleanup call. (#414) Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> * Update documentation with new gRPC message limits (#415) Co-authored-by: Raul Santelices <rasantel@users.noreply.github.com> Co-authored-by: Ranzo J Taylor, III <36489926+Ranzo3@users.noreply.github.com> Co-authored-by: Jeff Ngo <35587243+jeffngo@users.noreply.github.com> Co-authored-by: Ankur <ankursarin@gmail.com> Co-authored-by: kurthdelphix <89274759+kurthdelphix@users.noreply.github.com> Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> Co-authored-by: Tom Walsh <61519496+mothslaw@users.noreply.github.com> Co-authored-by: Raul Santelices <rasantel@users.noreply.github.com> Co-authored-by: Ranzo J Taylor, III <36489926+Ranzo3@users.noreply.github.com> Co-authored-by: Jeff Ngo <35587243+jeffngo@users.noreply.github.com> Co-authored-by: Ankur <ankursarin@gmail.com> Co-authored-by: kurthdelphix <89274759+kurthdelphix@users.noreply.github.com> Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> Co-authored-by: Tom Walsh <61519496+mothslaw@users.noreply.github.com>
mrburke
pushed a commit
that referenced
this pull request
Jan 20, 2022
* CP-7022 vSDK 4.0.0 release tasks (#416) * Bumping sdk to 4.0.2 and dvp-api to 1.6.3 due to bad upload of dvp-api 1.6.1 to pypi (#419) * Release (#418) * DOC-1074 Document password vault support for VSDK plugins (#347) * Correct Typo in Example, it should be UNIX not WINDOWS (#360) * Add documentation for gRPC message and memory limits #390 (#391) * Fix version number in doc header (#358) (#397) * Update Delphix Engine version required to 6.0.7.0. (#386) (#398) * Update SDK Docs deployment to use a deploy_key (#392) (#399) * CP-6005 Ensure vSDK test coverage (#403) * CP-6006 Futurize vSDK - Stage 1 (#404) * Add support for virtualCleanup decorator (#400) (#405) Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> * Fixes #401 Networking capabilities should be documented (#402) Fixes #401 Networking capabilities should be documented * CP-6009 Add to_str and to_byte helpers (#407) * CP-6621 bump sdk version to 4.0.0 (#409) * CP-6694 Update docs for SDK 4.0.0 (#410) * CP-7022 vSDK 4.0.0 release tasks * Update VirtualDelete flow diagram to include the virtual.cleanup call. (#414) Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> * Update documentation with new gRPC message limits (#415) Co-authored-by: Raul Santelices <rasantel@users.noreply.github.com> Co-authored-by: Ranzo J Taylor, III <36489926+Ranzo3@users.noreply.github.com> Co-authored-by: Jeff Ngo <35587243+jeffngo@users.noreply.github.com> Co-authored-by: Ankur <ankursarin@gmail.com> Co-authored-by: kurthdelphix <89274759+kurthdelphix@users.noreply.github.com> Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> Co-authored-by: Tom Walsh <61519496+mothslaw@users.noreply.github.com> * Release (#418) (#421) * DOC-1074 Document password vault support for VSDK plugins (#347) * Correct Typo in Example, it should be UNIX not WINDOWS (#360) * Add documentation for gRPC message and memory limits #390 (#391) * Fix version number in doc header (#358) (#397) * Update Delphix Engine version required to 6.0.7.0. (#386) (#398) * Update SDK Docs deployment to use a deploy_key (#392) (#399) * CP-6005 Ensure vSDK test coverage (#403) * CP-6006 Futurize vSDK - Stage 1 (#404) * Add support for virtualCleanup decorator (#400) (#405) Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> * Fixes #401 Networking capabilities should be documented (#402) Fixes #401 Networking capabilities should be documented * CP-6009 Add to_str and to_byte helpers (#407) * CP-6621 bump sdk version to 4.0.0 (#409) * CP-6694 Update docs for SDK 4.0.0 (#410) * CP-7022 vSDK 4.0.0 release tasks * Update VirtualDelete flow diagram to include the virtual.cleanup call. (#414) Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> * Update documentation with new gRPC message limits (#415) Co-authored-by: Raul Santelices <rasantel@users.noreply.github.com> Co-authored-by: Ranzo J Taylor, III <36489926+Ranzo3@users.noreply.github.com> Co-authored-by: Jeff Ngo <35587243+jeffngo@users.noreply.github.com> Co-authored-by: Ankur <ankursarin@gmail.com> Co-authored-by: kurthdelphix <89274759+kurthdelphix@users.noreply.github.com> Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> Co-authored-by: Tom Walsh <61519496+mothslaw@users.noreply.github.com> Co-authored-by: Raul Santelices <rasantel@users.noreply.github.com> Co-authored-by: Ranzo J Taylor, III <36489926+Ranzo3@users.noreply.github.com> Co-authored-by: Jeff Ngo <35587243+jeffngo@users.noreply.github.com> Co-authored-by: Ankur <ankursarin@gmail.com> Co-authored-by: kurthdelphix <89274759+kurthdelphix@users.noreply.github.com> Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> Co-authored-by: Tom Walsh <61519496+mothslaw@users.noreply.github.com> Co-authored-by: Raul Santelices <rasantel@users.noreply.github.com> Co-authored-by: Ranzo J Taylor, III <36489926+Ranzo3@users.noreply.github.com> Co-authored-by: Jeff Ngo <35587243+jeffngo@users.noreply.github.com> Co-authored-by: Ankur <ankursarin@gmail.com> Co-authored-by: kurthdelphix <89274759+kurthdelphix@users.noreply.github.com> Co-authored-by: Kurt Hutchison <kurth.hutchison@delphix.com> Co-authored-by: Tom Walsh <61519496+mothslaw@users.noreply.github.com>
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.
Problem:
Docs deployment is currently broken as the permissions for the GITHUB_TOKEN seem to have changed.
Our org seems to have the "restricted" default:
https://docs.github.com/en/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token
The publish-docs github action fails with:
https://github.com/delphix/virtualization-sdk/runs/2878474054
Solution:
Use a deploy_token instead.
Testing
Created a deploy key in my personal fork and tested the docs deployment.
Implementation:
Followed the instructions in:
https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-create-ssh-deploy-key
I've created a deploy key and secret called SDK_DEPLOY_KEY in our Delphix GitHub SDK repository.
I only updated the deployment to developer.delphix.com not the personal fork gh-pages since that seemed to work with the existing github token. If we update that as well, everyone would have to go and create a deploy key for their personal forks.
Merging to docs/3.1.0 first to get our public docs on developer.delphix.com up to date, will then merge this to develop.