Improve contributor DX #370
Conversation
Maybe obvious, but not really: I had an older set of deps installed and my integration tests were failing because of that. It took me 30 seconds to fix, but maybe this readme line will save that time to millions of developers, saving some trees as the end result! :)
docker-compose.yml
Outdated
| ports: | ||
| - "5432:5432" | ||
| - "${POSTGRES_PORT:-5432}:${POSTGRES_PORT:-5432}" |
There was a problem hiding this comment.
This was the real thing I wanted to add. I am running another Postgres server at that port and didn't want to turn it off just to run the tests for this package.
|
Warning Rate limit exceeded@janklan has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 15 minutes and 46 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
WalkthroughThe changes update the Docker Compose configuration for PostgreSQL to use environment variable parameterization for image version, credentials, database name, and port, with default values provided. The integration test documentation is updated to reference PostgreSQL version 17 and adds a step to run Changes
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
tests/Integration/README.md (1)
30-31: Clarifycomposer updatevscomposer install
Runningcomposer updatewill regeneratecomposer.lockand may introduce unintended upgrades. If the goal is simply to install the locked dependencies,composer installis safer. Please confirm whether you intend to update dependencies or just install them.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docker-compose.yml(1 hunks)tests/Integration/README.md(1 hunks)
🔇 Additional comments (2)
docker-compose.yml (1)
3-3: Parameterize PostgreSQL version for flexibility
Using${POSTGRES_VERSION:-17}here is an excellent way to allow contributors to test against different Postgres releases while retaining a sensible default. This improves DX by making the setup more adaptable.tests/Integration/README.md (1)
24-24: Update example to PostgreSQL 17
Bumping the Docker image frompostgres:14topostgres:17keeps the docs in sync with your default indocker-compose.yml.
While I was adding tests for #369, I tripped over a few details I'd like to propose a fix for.
Summary by CodeRabbit