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

feat: add Docker image #24

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat: add Docker image #24

wants to merge 4 commits into from

Conversation

JaeAeich
Copy link
Collaborator

@JaeAeich JaeAeich commented Oct 23, 2024

Description

Checklist

  • My code follows the contributing guidelines of this
    project, including, in particular, with regard to any style guidelines
  • The title of my PR complies with the Conventional Commits
    specification
    ; in particular, it clearly indicates
    that a change is a breaking change
  • I acknowledge that all my commits will be squashed into a single commit,
    using the PR title as the commit message
  • I have performed a self-review of my own code
  • I have commented my code in hard-to-understand areas
  • I have updated the user-facing documentation to describe any new or
    changed behavior
  • I have added type annotations for all function/class/method interfaces
    or updated existing ones (only for Python, TypeScript, etc.)
  • I have provided appropriate documentation (Google-style Python
    docstrings
    ) for all packages/modules/functions/classes/
    methods or updated existing ones
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature
    works
  • New and existing unit tests pass locally with my changes
  • I have not reduced the existing code coverage

Comments

Summary by Sourcery

New Features:

  • Add a new option to include a Docker image in the project configuration.

Copy link

sourcery-ai bot commented Oct 23, 2024

Reviewer's Guide by Sourcery

This PR adds Docker image support to the project by modifying the cookiecutter configuration to include a new option for Docker image generation.

Architecture diagram for Docker image integration

graph TD;
    A[Project Configuration] -->|Modified| B[Cookiecutter Configuration];
    B -->|Added| C[Docker Image Option];
    C --> D[Docker Image Generation];
Loading

File-Level Changes

Change Details Files
Added Docker image configuration option to cookiecutter template
  • Added new 'docker_image' parameter with default value 'y'
  • Maintained consistent JSON formatting with existing parameters
cookiecutter.json

Assessment against linked issues

Issue Objective Addressed Explanation
#5 Build and publish Docker image to Docker Hub via CI The PR only adds a 'docker_image' option to cookiecutter.json but does not implement the actual CI workflow for building and publishing Docker images to Docker Hub.

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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

@JaeAeich JaeAeich requested a review from uniqueg October 23, 2024 21:02
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 @JaeAeich - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Please complete the PR checklist. We need to ensure all requirements are met, particularly regarding documentation and testing.
  • The PR description is empty except for the issue reference. Please provide context about what this Docker image support will entail and how it will be implemented.
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.

@JaeAeich
Copy link
Collaborator Author

JaeAeich commented Oct 23, 2024

@uniqueg Docker build and push CI is still left, but since elixir's docker account name is elixircloud idk how to go about it, base case I do data sanitization on the cookicutter.github_user.name.

@JaeAeich
Copy link
Collaborator Author

image
image
image

@uniqueg uniqueg changed the title feat: add docker image feat: add Docker image Oct 29, 2024
Copy link
Member

@uniqueg uniqueg left a comment

Choose a reason for hiding this comment

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

LGTM except for the empty GH Actions workflow

Copy link
Member

Choose a reason for hiding this comment

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

Please add content or remove

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.

feat(ci): build and publish docker image
2 participants