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

Dev containers now work with "run as me" #1129

Merged
merged 2 commits into from
Feb 29, 2024
Merged

Dev containers now work with "run as me" #1129

merged 2 commits into from
Feb 29, 2024

Conversation

jbirddog
Copy link
Contributor

@jbirddog jbirddog commented Feb 29, 2024

Removed poetry install commands from the arena/backend images and perform the poetry installs via the volume mount after the images are built. Along with some environment variables to control where cache/venv directories, we can now run commands on the arena/backend containers "as me" (me being the current user on the host system not root). This is the same way the frontend dev container currently works.

Summary by CodeRabbit

  • Chores
    • Updated .gitignore to ignore .cache directory.
    • Enhanced Makefile with new targets for managing Python dependencies using Poetry.
    • Updated Dockerfiles to use Poetry version 1.8.1 for package management and improved cleanup procedures.
    • Adjusted Docker Compose configurations to set environment variables for better Poetry and Pre-Commit handling.

Copy link
Contributor

coderabbitai bot commented Feb 29, 2024

Walkthrough

Walkthrough

The recent updates focus on enhancing dependency management and Docker configurations. The introduction of Poetry for Python dependency management is notable, alongside Dockerfile adjustments for better package handling and environment setup. These changes aim to streamline development workflows, ensuring cleaner and more efficient builds.

Changes

File(s) Change Summary
.gitignore Adds .cache directory to ignored items.
Makefile Includes new targets for Poetry dependency management; updates existing targets for Poetry use.
dev.Dockerfile, .../dev.Dockerfile Updates Poetry version; optimizes package installations and cleanup.
dev.docker-compose.yml, .../dev.docker-compose.yml Adjusts environment variables for Poetry and Pre-Commit; cleans up configuration.

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between b2126e8 and 75918b0.
Files selected for processing (6)
  • .gitignore (1 hunks)
  • Makefile (4 hunks)
  • dev.Dockerfile (1 hunks)
  • dev.docker-compose.yml (1 hunks)
  • spiffworkflow-backend/dev.Dockerfile (1 hunks)
  • spiffworkflow-backend/dev.docker-compose.yml (1 hunks)
Additional comments: 8
.gitignore (1)
  • 12-12: The addition of the .cache directory to .gitignore is a good practice, ensuring that cache files are not tracked by Git, which helps in keeping the repository clean and secure.
dev.docker-compose.yml (1)
  • 7-10: The configuration updates in dev.docker-compose.yml, including setting environment variables for Poetry and Pre-Commit and specifying the user as ${RUN_AS}, align well with best practices for containerized development environments. These changes support the PR's objectives of enhancing the development setup and ensuring consistency across environments.
dev.Dockerfile (1)
  • 13-13: Upgrading Poetry to version 1.8.1 in dev.Dockerfile is a positive step towards utilizing the latest features and fixes from Poetry. It's recommended to verify the compatibility of this updated version with the project's dependencies.
spiffworkflow-backend/dev.Dockerfile (1)
  • 8-10: The updates in spiffworkflow-backend/dev.Dockerfile, including the cleanup commands for apt-get and adjustments in package installations, follow best practices for Dockerfile management. It's recommended to verify the compatibility of the specified versions of Poetry and pytest-xdist with the project's requirements.
spiffworkflow-backend/dev.docker-compose.yml (1)
  • 7-11: The updates in spiffworkflow-backend/dev.docker-compose.yml, including setting the user as ${RUN_AS} and adding environment variables for Poetry and cache directories, align with the PR's objectives of enhancing the development environment. These changes contribute to a more consistent and secure development process.
Makefile (3)
  • 32-32: The addition of the dev-env target in the Makefile, which includes the poetry-i target for managing Poetry dependencies, supports the PR's objectives of streamlining the development process. It's recommended to test these new and updated targets to ensure they function as expected.
  • 50-52: The be-poetry-i target in the Makefile, which runs poetry install, is a good addition for managing backend dependencies. Testing this target to ensure it works correctly with the project's setup is recommended.
  • 80-82: The poetry-i target, which runs poetry install --no-root, is a thoughtful addition to the Makefile for managing dependencies in the arena container. Verifying that this target functions correctly within the project's development environment is advisable.

@jbirddog jbirddog merged commit bb3a685 into main Feb 29, 2024
22 checks passed
@jbirddog jbirddog deleted the as_me branch February 29, 2024 10:27
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.

None yet

2 participants