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

updated docker push github action #2784

Merged
merged 1 commit into from
Mar 7, 2025

Conversation

imolorhe
Copy link
Collaborator

@imolorhe imolorhe commented Feb 26, 2025

Fixes

Checks

  • Ran yarn test-build
  • Updated relevant documentations
  • Updated matching config options in altair-static

Changes proposed in this pull request:

Summary by Sourcery

Update the push-docker GitHub Action to allow pushing Docker images as the latest release and to generate dynamic versions.

CI:

  • Add a 'release' input to the push-docker workflow to control whether to push the Docker image as the latest release.
  • Generate a dynamic version based on the Git SHA and commit timestamp if no version is provided as input.

Copy link

sourcery-ai bot commented Feb 26, 2025

Reviewer's Guide by Sourcery

This pull request updates the Docker push GitHub Action to include a 'release' input, which determines whether to push the Docker image as the 'latest' release. It also introduces a 'docker-vars' job to generate the version based on the commit SHA and timestamp. Finally, it enables the 'release' option in the release.yml workflow.

Sequence diagram for Docker push with release

sequenceDiagram
    participant GitHub Actions
    participant _push-docker.yml
    participant Docker Hub
    participant GitHub Container Registry

    GitHub Actions->>_push-docker.yml: triggers workflow with push=true, release=true, version
    _push-docker.yml->>_push-docker.yml: Determines version from inputs or commit SHA and timestamp
    _push-docker.yml->>Docker Hub: Pushes image with tag 'latest'
    _push-docker.yml->>Docker Hub: Pushes image with tag 'version'
    _push-docker.yml->>GitHub Container Registry: Pushes image with tag 'latest'
    _push-docker.yml->>GitHub Container Registry: Pushes image with tag 'version'
Loading

File-Level Changes

Change Details Files
Added a 'release' input to the _push-docker.yml workflow to control whether to push the Docker image as the 'latest' release.
  • Added 'release' input with type boolean, default false, and description 'Whether to push as latest release'.
  • Modified the 'tags' input to conditionally include the 'latest' tag based on the 'release' input.
.github/workflows/_push-docker.yml
Added a 'docker-vars' job to generate the version based on the commit SHA and timestamp.
  • Added a 'docker-vars' job that runs on ubuntu-latest.
  • The job outputs a 'version' variable, which is either the input version or a combination of the commit SHA and timestamp.
  • The job includes steps to get the Git commit timestamp and expose environment variables.
.github/workflows/_push-docker.yml
Enabled the 'release' option in the release.yml workflow.
  • Added release: true to the _push-docker.yml workflow call.
.github/workflows/release.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @imolorhe - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a job to verify the docker image was successfully pushed.
  • It might be helpful to add a description of the 'release' input to explain its purpose.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link

github-actions bot commented Feb 26, 2025

Visit the preview URL for this PR (updated for commit 0cd6168):

https://altair-gql--pr2784-imolorhe-updated-doc-ijotni5f.web.app

(expires Fri, 14 Mar 2025 16:05:42 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 02d6323d75a99e532a38922862e269d63351a6cf

@imolorhe imolorhe force-pushed the imolorhe/updated-docker-push-action branch from 0f98e68 to 225ad86 Compare March 7, 2025 14:43
@imolorhe imolorhe force-pushed the imolorhe/updated-docker-push-action branch from 225ad86 to 0cd6168 Compare March 7, 2025 16:01
@imolorhe imolorhe added this pull request to the merge queue Mar 7, 2025
Merged via the queue into master with commit 798104e Mar 7, 2025
16 checks passed
@imolorhe imolorhe deleted the imolorhe/updated-docker-push-action branch March 7, 2025 20:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant