update

[5hojib]

Summary by Sourcery

Update deployment workflow by renaming input variables, upgrading Heroku deploy action, and adding Docker support.

Enhancements:

• Update Heroku deploy action to version 2 for improved deployment process.

CI:

• Rename input variable from HK_TEAM_NAME to HEROKU_TEAM_NAME in GitHub Actions workflow.

Deployment:

• Add a Dockerfile for containerized deployment, including installation of dependencies from requirements.txt.

Documentation:

• Update README.md to reflect changes in deployment instructions, including the optional HEROKU_TEAM_NAME input.

Chores:

• Add a requirements.txt file listing all Python dependencies for the project.

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR updates the Heroku deployment workflow and project configuration. The changes include renaming a Heroku team environment variable, updating the deployment action version, adding dependency management files, and simplifying the deployment instructions in the README.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Update GitHub Actions workflow for Heroku deployment	Rename HK_TEAM_NAME input variable to HEROKU_TEAM_NAME for better clarity Update heroku-deploy-action from v1.0.1 to v2 Remove explicit checkout reference to deploy branch	.github/workflows/deploy.yml
Add Docker configuration and dependency management	Create Dockerfile using 5hojib/aeon as base image Add requirements.txt with project dependencies Include sample configuration environment file	Dockerfile requirements.txt sample_config.env
Simplify deployment documentation	Remove instruction about unchecking 'Copy the default branch only' option Add documentation for optional HEROKU_TEAM_NAME variable	README.md

---

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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

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

Overall Comments:

• Consider removing --break-system-packages from pip install in Dockerfile as it can lead to system package conflicts. Instead, use a virtual environment or multi-stage build if needed.
• It's recommended to pin dependency versions in requirements.txt (e.g., package==1.2.3) to ensure build reproducibility, unless these are being managed in the base image.

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 ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}