Docs auto update#43
Open
joaopapereira wants to merge 3 commits into
Open
Conversation
Signed-off-by: João Pereira <joao.pereira@broadcom.com>
Signed-off-by: João Pereira <joao.pereira@broadcom.com>
praveenrewar
reviewed
May 6, 2025
| prepare-documentation-update: | ||
| runs-on: ubuntu-latest | ||
| needs: [process-release-information,update-releases-yaml] | ||
| if: endsWith(github.event.client_payload.tagName, '.0') |
Member
There was a problem hiding this comment.
Will this also include prereleases? Do we want to include them?
Member
Author
There was a problem hiding this comment.
what do you mean by prereleases?
Member
Author
There was a problem hiding this comment.
I do not think that we do prereleases in our tools, but if we do we can look into it later
There was a problem hiding this comment.
Pull request overview
This PR aims to automate documentation updates as part of the published release workflow, and adjusts the generated install.sh template to verify downloaded binaries using a checksum tool available on the target system.
Changes:
- Add a new GitHub Actions job to auto-run the website documentation release script and push changes to the website repo on
.0releases. - Update the
install.shtemplate to select a checksum utility dynamically and use it for verification.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| scripts/install_sh/install.sh.txt | Updates checksum command selection/usage in the generated install script. |
| .github/workflows/published_release.yml | Adds a documentation auto-update job triggered on .0 releases. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+17
to
+24
| # Check for required commands | ||
| check_command sha256sum || check_command sha1sum | ||
|
|
||
| # Set checksum command based on availability | ||
| CHECKSUM_CMD=sha256sum | ||
| if ! command -v $CHECKSUM_CMD >/dev/null 2>&1; then | ||
| CHECKSUM_CMD=sha1sum | ||
| fi |
| fi | ||
|
|
||
| shasum -v 1>/dev/null 2>&1 || (echo "Missing shasum binary" && exit 1) | ||
| $CHECKSUM_CMD -v 1>/dev/null 2>&1 || (echo "Missing shasum binary" && exit 1) |
Comment on lines
+185
to
+190
| - name: Checkout website | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
| repository: 'github.com/carvel-dev/carvel' | ||
| path: website |
| AUTHOR_NAME='carvel-bot' | ||
| MESSAGE="chore: auto-update documentation for ${{ github.event.client_payload.toolName }} ${docVersion} ${timestamp}" | ||
|
|
||
| remote_repo="git@github.com:${REPOSITORY}" |
Comment on lines
+192
to
+195
| run: | | ||
| pushd website/site | ||
| docVersion=`echo ${{ github.event.client_payload.tagName }} | awk -F. '{print $1"."$2".x"}'` | ||
| ./hack/release-doc.sh ${{ github.event.client_payload.toolName }} ${docVersion} |
Comment on lines
+204
to
+208
| tempkey=`basename $0` | ||
| TMP_DEPLOY_PRIV_KEY=`mktemp /tmp/${tempkey}.XXXXXX` || exit 1 | ||
| echo "${{ secrets.INSTALL_SH_DEPLOY_PRIVATE_KEY }}" > $TMP_DEPLOY_PRIV_KEY | ||
| eval $(ssh-agent -s) | ||
| ssh-add ${TMP_DEPLOY_PRIV_KEY} |
- Ensure the shasum logic is correct - Update all the version of the actions being used to the latest Signed-off-by: Joao Pereira <joaopapereira@gmail.com>
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
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.
No description provided.