Skip to content
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

add option to trigger release-assets workflow manually #280

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

aobort
Copy link
Collaborator

@aobort aobort commented Jan 25, 2025

Release v0.4.1 did not trigger creation of assets, hence documentation is not consistent with the state of the release:

  1. Install etcd-operator:

kubectl apply -f https://github.com/aenix-io/etcd-operator/releases/latest/download/etcd-operator.yaml

but the etcd-operator.yaml does not exists for release v0.4.1 (latest)

To solve this bug, we can manually trigger the workflow targeting it to the tag v0.4.1.

Fixes: #263

Summary by CodeRabbit

  • Chores
    • Enhanced GitHub Actions workflow by adding manual trigger capability
    • Improved workflow flexibility for release asset generation

Copy link
Contributor

coderabbitai bot commented Jan 25, 2025

Walkthrough

The pull request modifies the GitHub Actions workflow file .github/workflows/release-assets.yaml by adding the workflow_dispatch event. This change allows the workflow to be manually triggered through the GitHub Actions interface, in addition to its existing automatic trigger when a release is created. The modification provides more flexibility in workflow execution without altering the existing workflow logic or job configurations.

Changes

File Change Summary
.github/workflows/release-assets.yaml Added workflow_dispatch event to enable manual workflow triggering

Assessment against linked issues

Objective Addressed Explanation
Resolve 404 error for installation instructions [#263] This workflow change does not address the installation instruction issue

Poem

🐰 A workflow with a new dispatch power,
Triggered by hand in GitHub's tower
Manual control, a rabbit's delight
Releases now dance at our might!
Hop, hop, workflow go! 🚀


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the chore label Jan 25, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🔭 Outside diff range comments (1)
.github/workflows/release-assets.yaml (1)

Line range hint 26-31: Adapt tag handling for manual workflow runs.

The current tag extraction needs to account for both automatic (release) and manual triggers. For manual runs, use the input parameter instead of github.ref_name.

       - name: Get tag from current run
         run: |
-          TAG=${{ github.ref_name }}
+          if [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then
+            TAG=${{ inputs.tag }}
+          else
+            TAG=${{ github.ref_name }}
+          fi
           echo "Tag for packaging chart is $TAG"
           echo "RELEASE_TAG=${TAG}" >> $GITHUB_ENV
           echo "RELEASE_TAG_TRIMMED_V=${TAG#v}" >> $GITHUB_ENV
🧹 Nitpick comments (1)
.github/workflows/release-assets.yaml (1)

Line range hint 32-32: Add error handling for the build step.

Consider adding error checking and better logging for the manifest build step to help diagnose issues when the workflow fails.

-      - run: make build-dist-manifests IMG=${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${RELEASE_TAG}
+      - name: Build distribution manifests
+        run: |
+          set -euo pipefail
+          echo "Building manifests for image: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${RELEASE_TAG}"
+          make build-dist-manifests IMG=${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${RELEASE_TAG}
+          echo "Verifying generated manifests..."
+          for file in etcd-operator.yaml etcd-operator.crds.yaml etcd-operator.non-crds.yaml; do
+            if [[ ! -f "dist/$file" ]]; then
+              echo "Error: $file was not generated"
+              exit 1
+            fi
+          done
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bfcf533 and e70d6e1.

📒 Files selected for processing (1)
  • .github/workflows/release-assets.yaml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: test on k8s latest version
  • GitHub Check: test-e2e on k8s latest version
  • GitHub Check: test-e2e on k8s previous version
  • GitHub Check: test on k8s previous version
  • GitHub Check: test-e2e on k8s penultimate version
  • GitHub Check: pre-commit
  • GitHub Check: test on k8s penultimate version
🔇 Additional comments (1)
.github/workflows/release-assets.yaml (1)

Line range hint 15-17: LGTM! Good security practices in place.

The workflow follows security best practices by:

  • Using pinned action versions
  • Setting minimal required permissions (contents: write)

.github/workflows/release-assets.yaml Show resolved Hide resolved
@aobort aobort enabled auto-merge January 25, 2025 20:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Website install instruction no longer works since 0.4.1
1 participant