Skip to content

ci: auto-publish sdm for each release #122

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

Merged
merged 1 commit into from
Dec 5, 2024

Conversation

aaronsteers
Copy link
Contributor

@aaronsteers aaronsteers commented Dec 5, 2024

Originally I had wanted to wait for:

This PR enables auto-release anyway, on the basis that if Builder adopts the CDK version before Platform does, it also creates an outage.

@github-actions github-actions bot added the ci label Dec 5, 2024
Copy link
Contributor

coderabbitai bot commented Dec 5, 2024

📝 Walkthrough

Walkthrough

The pull request modifies the .github/workflows/pypi_publish.yml workflow to enhance version detection and publishing processes. Key updates include changes to job conditions for publish_sdm and publish_cdk, allowing them to be triggered by both push events and manual dispatches. The version-setting logic in the build job has been refined to improve error handling and clarity regarding pre-release versions. Overall, these changes aim to improve the reliability of versioning and publishing workflows.

Changes

File Change Summary
.github/workflows/pypi_publish.yml - Updated workflow name to Packaging and Publishing.
- Modified job conditions for publish_sdm and publish_cdk to allow triggering on push events and manual dispatches.
- Refined version-setting logic in build job, including checks for empty and matching versions, and clarified handling of pre-release versions.

Possibly related PRs

Suggested labels

ci

Suggested reviewers

  • ChristoGrab
  • maxi297

What do you think about these suggestions?


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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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 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.

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: 0

🧹 Outside diff range and nitpick comments (1)
.github/workflows/pypi_publish.yml (1)

Line range hint 201-211: How about enhancing the version check robustness? wdyt?

The version check in the publish_sdm job could be more descriptive and handle edge cases better. Here's a suggestion:

       - name: "Check for existing tag (version: ${{ env.VERSION || 'none' }} )"
         if: env.VERSION != ''
         run: |
           tag="airbyte/source-declarative-manifest:${{ env.VERSION }}"
-          if [ -z "$tag" ]; then
+          if [ -z "${{ env.VERSION }}" ]; then
             echo "Error: VERSION is not set. Ensure the tag follows the format 'refs/tags/vX.Y.Z'."
             exit 1
           fi
           echo "Checking if tag '$tag' exists on DockerHub..."
           if DOCKER_CLI_EXPERIMENTAL=enabled docker manifest inspect "$tag" > /dev/null 2>&1; then
-            echo "The tag '$tag' already exists on DockerHub. Skipping publish to prevent overwrite."
+            echo "Error: The tag '$tag' already exists on DockerHub."
+            echo "To prevent accidental overwrites, please:"
+            echo "1. Ensure you're publishing a new version"
+            echo "2. Delete the existing tag if you really need to republish"
             exit 1
           fi

The changes:

  1. Check VERSION directly instead of the constructed tag
  2. Provide more actionable error messages
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 51d04dd and 38db076.

📒 Files selected for processing (1)
  • .github/workflows/pypi_publish.yml (1 hunks)
🔇 Additional comments (1)
.github/workflows/pypi_publish.yml (1)

154-155: LGTM! The job conditions look well-structured.

The updated conditions for publish_sdm nicely handle both automated (push events with version tags) and manual triggers. This aligns perfectly with the workflow's purpose of flexible publishing control.

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.

1 participant