test: simplify test-project's docker compose command and add Window's version#1452
Conversation
WalkthroughThe pull request updates the GitHub Actions test workflow and the associated documentation. In the workflow file, the Docker Compose command has been modified to remove the Changes
Possibly related issues
Possibly related PRs
Suggested labels
Suggested reviewers
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:
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
CodeRabbit Configuration File (
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
.github/workflows/pr-testing-with-test-project.yml (2)
40-40: Actionable: Review Checkout Pinning
The checkout step on line 40 is explicitly pinned to a commit (f43a0e5ff2bd294095638e18286ca9a3d1956744). While this increases reproducibility, consider updating to a tagged release in the future for improved clarity and maintainability.
60-62: Clarify Docker Compose Command Changes
The updated "Run test" step (line 61) removes the--remove-orphansflag and now uses:NODE_IMAGE_TAG=${{ matrix.node }} docker compose up --abort-on-container-exit --force-recreatePlease verify that the removal of
--remove-orphansdoes not result in unintended orphan container behavior during test execution. Additionally, note that the command usesdocker compose(without hyphen), which is the Docker Compose V2 syntax; ensure that this is intentional and consistent with your environment.apps/generator/test/test-project/README.md (2)
6-6: Correct Operating System Branding
The command description for Linux/macOS on line 6 currently uses "Linux/MacOS". For accuracy and brand consistency, please change "MacOS" to "macOS".Proposed diff:
-Linux/MacOS: `NODE_IMAGE_TAG=18 docker-compose up --abort-on-container-exit --force-recreate`. +Linux/macOS: `NODE_IMAGE_TAG=18 docker-compose up --abort-on-container-exit --force-recreate`.🧰 Tools
🪛 LanguageTool
[grammar] ~6-~6: The operating system from Apple is written “macOS”.
Context: ...e and run the following command: Linux/MacOS: `NODE_IMAGE_TAG=18 docker-compose up -...(MAC_OS)
8-8: Enhance Windows Command Formatting
The Windows command on line 8 is given as:set NODE_IMAGE_TAG=18&& docker-compose up --abort-on-container-exit --force-recreateIt is common practice to include a space before and after the
&&operator for better readability and to avoid potential issues. Consider updating it to:set NODE_IMAGE_TAG=18 && docker-compose up --abort-on-container-exit --force-recreateProposed diff:
-set NODE_IMAGE_TAG=18&& docker-compose up --abort-on-container-exit --force-recreate +set NODE_IMAGE_TAG=18 && docker-compose up --abort-on-container-exit --force-recreate
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.github/workflows/pr-testing-with-test-project.yml(2 hunks)apps/generator/test/test-project/README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
apps/generator/test/test-project/README.md
[grammar] ~6-~6: The operating system from Apple is written “macOS”.
Context: ...e and run the following command: Linux/MacOS: `NODE_IMAGE_TAG=18 docker-compose up -...
(MAC_OS)
🔇 Additional comments (1)
apps/generator/test/test-project/README.md (1)
4-4: Improve Instruction Clarity
The introductory instruction on line 4 clearly instructs users to run tests via Docker Compose rather thannpm test. This provides improved guidance, especially for environments that rely on containerized testing.
|
In |
derberg
changed the title
|
|
|
/rtm |
3 participants
Description
Simplifies the docker compose command documented in the test-project README inside generator test.
Related issue(s)
Part of #1425
Summary by CodeRabbit
Chores
Documentation