improve docker image release tag process #9407

abhay084 · 2025-01-08T10:40:33Z

Change Description

Description of change / link to associated issue.

This PR is associated with this issue: #9397

When a tag is pushed that follows the v* format (e.g., v1.0.0, v2.1.0), it will push a Docker image tagged with both the specific release version and latest
When the scheduled cron job triggers the action, the IMAGE_TAG is set to daily-testing-YYYYMMDD and the image will be tagged accordingly.

Steps to Test

Steps for reviewers to follow to test the change.

Pull Request Checklist

Testing

Your PR passes all CI checks.
Tests covering the positive and negative (error paths) are included.
Bug fixes contain tests triggering the bug to prevent regressions.

Code Style and Documentation

The change obeys the Code Documentation and Commenting guidelines, and lines wrap at 80.
Commits follow the Ideal Git Commit Structure.
Any new logging statements use an appropriate subsystem and logging level.
Any new lncli commands have appropriate tags in the comments for the rpc in the proto file.
There is a change description in the release notes, or [skip ci] in the commit message for small changes.

📝 Please see our Contribution Guidelines for further guidance.

coderabbitai · 2025-01-08T10:40:41Z

Important

Review skipped

Auto reviews are limited to specific labels.

🏷️ Labels to auto review (1)

llm-review

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Finishing Touches

📝 Generate Docstrings

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/workflows/docker.yml

guggero · 2025-01-08T15:57:03Z

.github/workflows/docker.yml

-          tags: "${{ env.DOCKER_REPO }}/${{ env.DOCKER_IMAGE }}:${{ env.IMAGE_TAG }}"
+          tags: |
+            "${{ env.DOCKER_REPO }}/${{ env.DOCKER_IMAGE }}:${{ env.IMAGE_TAG }}" 
+            "${{ env.DOCKER_REPO }}/${{ env.DOCKER_IMAGE }}:latest"


I think we should only tag latest for non-RC builds. So this should match on the env.IMAGE_TAG to not contain .rc.

added a condition to check if that contains ".rc" and update tag with latest if "rc " is not found there.

That's a great update, and it definitely improves the tagging process by avoiding latest for RC builds. However, I think we should consider that .rc isn't the only type of non-official release we might encounter. For instance, there could be other non-stable or experimental tags like .beta, .alpha, or other custom suffixes.

Instead of relying on a "deny rule" (excluding .rc), I suggest we flip this logic and implement an "allow rule." This would validate that the version is strictly a raw semantic version, like v1.2.3, without any additional suffixes. This approach ensures latest is only applied to stable versions and avoids potential edge cases where other non-official tags might inadvertently get marked as latest.

What do you think? It would add some robustness to the tagging logic and better future-proof the pipeline.

guggero

Tried running this against my fork and got:

The template is not valid. .github/workflows/docker.yml (Line: 52, Col: 17): The following format string is invalid: {}/{}:latest

Also, can you please squash the commits into a single one?

lightninglabs-deploy · 2025-01-24T04:37:02Z

@abhay084, remember to re-request review from reviewers when ready

improve docker image release tag process

9a80137

abhay084 mentioned this pull request Jan 8, 2025

[feature]: Docker Hub Tag #9397

Open

saubyk added the docker Docker-related PRs/Issues label Jan 8, 2025

saubyk assigned abhay084 Jan 8, 2025

saubyk linked an issue Jan 8, 2025 that may be closed by this pull request

[feature]: Docker Hub Tag #9397

Open

guggero reviewed Jan 8, 2025

View reviewed changes

exclude tag if it container .rc in release tag

12304d3

abhay084 requested a review from guggero January 9, 2025 18:43

guggero reviewed Jan 15, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

improve docker image release tag process #9407

improve docker image release tag process #9407

abhay084 commented Jan 8, 2025 •

edited

Loading

coderabbitai bot commented Jan 8, 2025 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

guggero Jan 8, 2025

abhay084 Jan 9, 2025

GustavoStingelin Jan 17, 2025

guggero left a comment

lightninglabs-deploy commented Jan 24, 2025

improve docker image release tag process #9407

Are you sure you want to change the base?

improve docker image release tag process #9407

Conversation

abhay084 commented Jan 8, 2025 • edited Loading

Change Description

Steps to Test

Pull Request Checklist

Testing

Code Style and Documentation

coderabbitai bot commented Jan 8, 2025 • edited Loading

Review skipped

Finishing Touches

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

guggero Jan 8, 2025

Choose a reason for hiding this comment

abhay084 Jan 9, 2025

Choose a reason for hiding this comment

GustavoStingelin Jan 17, 2025

Choose a reason for hiding this comment

guggero left a comment

Choose a reason for hiding this comment

lightninglabs-deploy commented Jan 24, 2025

abhay084 commented Jan 8, 2025 •

edited

Loading

coderabbitai bot commented Jan 8, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)