Conversation
…vironment instructions
|
Warning Rate limit exceeded@johlju has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 19 minutes and 49 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)
WalkthroughA new contribution guide was added, the README was rewritten to provide a high-level overview and streamlined usage instructions, eight words were added to the spell checker configuration, the Docker Compose file was updated to use an environment variable for the volume mount path, a new GitHub Actions workflow was introduced to automate building and publishing Docker images on version tag pushes, and the Dockerfile was modified to enhance automatic directory navigation in the root user's shell configuration. Changes
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
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (4)
CONTRIBUTING.md(1 hunks)README.md(1 hunks)cspell.json(1 hunks)docker-compose.yml(1 hunks)
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[grammar] ~1-~1: Use correct spacing
Context: # Contributing to devshell-dsc Thank you for your interest in contribut...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~3-~3: Use correct spacing
Context: ... run, and rebuild the development shell locally. ## Prerequisites - Docker installed on you...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~7-~7: Use modal and auxiliary verbs correctly
Context: ...ent shell locally. ## Prerequisites - Docker installed on your system. ## Running a...
(QB_NEW_EN_OTHER_ERROR_IDS_24)
[grammar] ~7-~7: Use correct spacing
Context: ...erequisites - Docker installed on your system. ## Running and Testing the DevShell Contain...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~9-~9: Use correct spacing
Context: ...m. ## Running and Testing the DevShell Container To launch the development shell, run the...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~11-~11: Use correct spacing
Context: ...hell, run the following command in your terminal: ### Using Docker To launch the container an...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~13-~13: Use correct spacing
Context: ...ng command in your terminal: ### Using Docker To launch the container and login as _ro...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~15-~15: Use the right verb tense
Context: ...ing Docker To launch the container and login as root: ```sh docker run --rm -it d...
(QB_NEW_EN_OTHER_ERROR_IDS_13)
[grammar] ~15-~15: Use correct spacing
Context: ...r To launch the container and login as root: sh docker run --rm -it devshell:dsc ### Using Docker Compose To launch the cont...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~21-~21: Use correct spacing
Context: ... -it devshell:dsc ``` ### Using Docker Compose To launch the container as developer...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~23-~23: Use correct spacing
Context: ...r** with your current folder mounted at /home/developer/work: sh docker-compose run --rm dev ## Rebuilding the Container ### Docker ``...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~29-~29: Use correct spacing
Context: ...ose run --rm dev ## Rebuilding the Container ### Docker sh docker build -t devshell:d...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~37-~37: Use correct spacing
Context: ...build -t devshell:dsc . ### Docker Compose sh docker-compose build dev ### Docker (No Cache) sh docker build --...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~43-~43: Use correct spacing
Context: ...r-compose build dev ### Docker (No Cache) sh docker build --no-cache -t devshell:dsc . ### Docker Compose (No Cache) sh docker-...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~49-~49: Use correct spacing
Context: ...shell:dsc . ### Docker Compose (No Cache) sh docker-compose build --no-cache dev ``` --- For any additional contributions, bug re...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
README.md
[grammar] ~1-~1: Use correct spacing
Context: # DevShell DSC Container Dockerized Ubuntu 24.04 dev environment ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~3-~3: Use correct spacing
Context: ...3 pre-configured for seamless developer workflows. ## Included Tools - PowerShell 7.5.2 & DSC...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~5-~5: Use correct spacing
Context: ...mless developer workflows. ## Included Tools - PowerShell 7.5.2 & DSC v3 support - .NET...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~10-~10: Use proper capitalization
Context: ...& DSC v3 support - .NET SDK 8.0 - Git - Openssh Client - Configured non-root 'developer...
(QB_NEW_EN_OTHER_ERROR_IDS_6)
[grammar] ~12-~12: Use hyphens correctly
Context: ...- Zsh & Oh My Zsh with autosuggestions, syntax-highlighting, fast-syntax-highlighting ...
(QB_NEW_EN_OTHER_ERROR_IDS_29)
[grammar] ~12-~12: There might be a problem here.
Context: ...h autosuggestions, syntax-highlighting, fast-syntax-highlighting & zsh-autocomplete, and Po...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~13-~13: Use correct spacing
Context: ...th MesloLGS NF fonts - Health check via PowerShell ## Prerequisites Ensure the following are ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~17-~17: There might be a mistake here.
Context: ...he following are installed on your host system: - Docker (version >= 28.2) - Docker Compo...
(QB_NEW_EN_OTHER)
[grammar] ~20-~20: Use correct spacing
Context: ...n >= 28.2) - Docker Compose (version >= 2.36) ## Quick Start Launch an interactive devel...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~22-~22: Use correct spacing
Context: ...ker Compose (version >= 2.36) ## Quick Start Launch an interactive development shell ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~24-~24: There might be a mistake here.
Context: ...pment shell with your project directory mounted: bash # Standard user docker-compose -f "${HOME}/source/devshell-dsc/docker-compose.yml" run --rm dev # Root user docker-compose -f "${HOME}/source/devshell-dsc/docker-compose.yml" run --rm --user root dev
(QB_NEW_EN_OTHER)
🔇 Additional comments (3)
cspell.json (1)
14-16: Dictionary additions look goodThe newly-added terms are project-specific and spelled correctly. No further action needed.
CONTRIBUTING.md (1)
17-19: Mirror the Compose workflow by mounting the current directoryThe plain-Docker example runs without mounting the working folder, so the container cannot see the project files—unlike the Compose command below.
-docker run --rm -it devshell:dsc +docker run --rm -it -v "${PWD}:/home/developer/work" devshell:dscKeeps the two invocation styles functionally equivalent.
README.md (1)
26-31: Clarify the${PWD}bind-mount side-effectBecause the compose file uses
${PWD}inside thevolumesdefinition, running the command from a directory outside your project mounts that unrelated path. Consider adding a short note in the README so users aren’t surprised, e.g.:“The container will mount the directory you run this command from to
/home/developer/work.”No code change required; just documentation clarity.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (3)
CONTRIBUTING.md(1 hunks)README.md(1 hunks)docker-compose.yml(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~1-~1: Use correct spacing
Context: # DevShell DSC Container Dockerized Ubuntu 24.04 dev environment ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~3-~3: Use correct spacing
Context: ...3 pre-configured for seamless developer workflows. ## Included Tools - PowerShell 7.5.2 & DSC...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~5-~5: Use correct spacing
Context: ...mless developer workflows. ## Included Tools - PowerShell 7.5.2 & DSC v3 support - .NET...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~13-~13: Use correct spacing
Context: ...th MesloLGS NF fonts - Health check via PowerShell ## Prerequisites Ensure the following are ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~17-~17: Use correct spacing
Context: ...he following are installed on your host system: - Docker (version >= 28.2) - Docker Compos...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~20-~20: Use correct spacing
Context: ...n >= 28.2) - Docker Compose (version >= 2.36) ## Quick Start Launch an interactive devel...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~22-~22: Use correct spacing
Context: ...ker Compose (version >= 2.36) ## Quick Start Launch an interactive development shell ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~24-~24: Use correct spacing
Context: ...pment shell with your project directory mounted: bash # Standard user docker-compose -f "${HOME}/source/devshell-dsc/docker-compose.yml" run --rm dev # Root user docker-compose -f "${HOME}/source/devshell-dsc/docker-compose.yml" run --rm --user root dev
(QB_NEW_EN_OTHER_ERROR_IDS_5)
CONTRIBUTING.md
[grammar] ~1-~1: Use correct spacing
Context: # Contributing to devshell-dsc Thank you for your interest in contribut...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~3-~3: Use correct spacing
Context: ... run, and rebuild the development shell locally. ## Prerequisites - Docker installed on you...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~7-~7: Use modal and auxiliary verbs correctly
Context: ...ent shell locally. ## Prerequisites - Docker installed on your system. ## Running a...
(QB_NEW_EN_OTHER_ERROR_IDS_24)
[grammar] ~7-~7: Use correct spacing
Context: ...erequisites - Docker installed on your system. ## Running and Testing the DevShell Contain...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~9-~9: Use correct spacing
Context: ...m. ## Running and Testing the DevShell Container To launch the development shell, run the...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~11-~11: Use correct spacing
Context: ...hell, run the following command in your terminal: ### Using Docker To launch the container an...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~13-~13: Use correct spacing
Context: ...ng command in your terminal: ### Using Docker To launch the container and log in as _r...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~15-~15: Use correct spacing
Context: ... To launch the container and log in as root: sh docker run --rm -it devshell:dsc ### Using Docker Compose To launch the cont...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~21-~21: Use correct spacing
Context: ... -it devshell:dsc ``` ### Using Docker Compose To launch the container as developer...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~23-~23: Use correct spacing
Context: ...r** with your current folder mounted at /home/developer/work: sh docker-compose run --rm dev ## Rebuilding the Container ### Docker ``...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~29-~29: Use correct spacing
Context: ...ose run --rm dev ## Rebuilding the Container ### Docker sh docker build -t devshell:d...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~37-~37: Use correct spacing
Context: ...build -t devshell:dsc . ### Docker Compose sh docker-compose build dev ### Docker (No Cache) sh docker build --...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~43-~43: Use correct spacing
Context: ...r-compose build dev ### Docker (No Cache) sh docker build --no-cache -t devshell:dsc . ### Docker Compose (No Cache) sh docker-...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~49-~49: Use correct spacing
Context: ...shell:dsc . ### Docker Compose (No Cache) sh docker-compose build --no-cache dev ``` --- For any additional contributions, bug re...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
🔇 Additional comments (4)
docker-compose.yml (2)
6-6: Path now correctly quoted – nice catch 👍Quoting the bind-mount path resolves the cross-platform path-with-spaces issue flagged earlier.
6-6:${PWD}may be undefined on PowerShell → verify cross-shell behaviour
docker composeexpands environment variables that exist in the shell’s environment, not shell variables.
On Windows PowerShell$PWDis not exported as an environment variable, so${PWD}will resolve to an empty string and mount the host root (/), breaking the dev workflow.Consider a safer default such as:
- - "${PWD}:/home/developer/work" + - "${LOCAL_WORKDIR:-${PWD:-.}}:/home/developer/work"and document setting
LOCAL_WORKDIRwhen launching from shells wherePWDis missing.README.md (1)
10-10: Capitalisation fixed – thanks for following up“OpenSSH Client” now uses the canonical spelling, matching the earlier review note.
CONTRIBUTING.md (1)
15-16: “log in” verb form adopted – looks goodThe wording now reads naturally (“log in as root”).
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
README.md (1)
1-3: Strip trailing double-spaces that only add markdown noiseSeveral lines (1, 3, 5, etc.) still end with two spaces to force a hard line-break. GitHub already breaks headings/paragraphs on a blank line, so these invisible characters bloat diffs and trigger spelling tools.
-# DevShell DSC Container·· - -Dockerized Ubuntu 24.04 dev environment with Zsh (Oh My Zsh & Powerlevel10k), PowerShell & DSC v3 pre-configured for seamless developer workflows.·· +# DevShell DSC Container + +Dockerized Ubuntu 24.04 dev environment with Zsh (Oh My Zsh & Powerlevel10k), PowerShell & DSC v3 pre-configured for seamless developer workflows.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~1-~1: Use correct spacing
Context: # DevShell DSC Container Dockerized Ubuntu 24.04 dev environment ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~3-~3: Use correct spacing
Context: ...3 pre-configured for seamless developer workflows. ## Included Tools - PowerShell 7.5.2 & DSC...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~5-~5: Use correct spacing
Context: ...mless developer workflows. ## Included Tools - PowerShell 7.5.2 & DSC v3 support - .NET...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~13-~13: Use correct spacing
Context: ...th MesloLGS NF fonts - Health check via PowerShell ## Prerequisites Ensure the following are ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~17-~17: Use correct spacing
Context: ...he following are installed on your host system: - Docker (version >= 28.2) - Docker Compos...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~20-~20: Use correct spacing
Context: ...n >= 28.2) - Docker Compose (version >= 2.36) ## Quick Start Launch an interactive devel...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~22-~22: Use correct spacing
Context: ...ker Compose (version >= 2.36) ## Quick Start Launch an interactive development shell ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~24-~24: Use correct spacing
Context: ...pment shell with your project directory mounted: >[!NOTE] >The container will mount the di...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~27-~27: Use correct spacing
Context: ... directory you run this command from to /home/developer/work. bash # Standard user docker-compose -f "${HOME}/source/devshell-dsc/docker-compose.yml" run --rm dev # Root user docker-compose -f "${HOME}/source/devshell-dsc/docker-compose.yml" run --rm --user root dev
(QB_NEW_EN_OTHER_ERROR_IDS_5)
There was a problem hiding this comment.
Actionable comments posted: 5
♻️ Duplicate comments (1)
CONTRIBUTING.md (1)
99-101: Use “log in” (verb) for consistency-Login to GHCR and push: +Log in to GHCR and push:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (3)
.github/workflows/docker-publish.yml(1 hunks)CONTRIBUTING.md(1 hunks)cspell.json(1 hunks)
🧰 Additional context used
🪛 actionlint (1.7.7)
.github/workflows/docker-publish.yml
18-18: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue
(action)
21-21: the runner of "docker/setup-qemu-action@v2" action is too old to run on GitHub Actions. update the action's version to fix this issue
(action)
24-24: the runner of "docker/setup-buildx-action@v2" action is too old to run on GitHub Actions. update the action's version to fix this issue
(action)
27-27: the runner of "docker/login-action@v2" action is too old to run on GitHub Actions. update the action's version to fix this issue
(action)
34-34: the runner of "docker/login-action@v2" action is too old to run on GitHub Actions. update the action's version to fix this issue
(action)
…ory path instructions
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (1)
README.md (1)
29-35: Hard-coded compose path defeats the “dynamic folder” goalThe commands still assume the repo must live in
$HOME/source/devshell-dsc.
Using the current working directory keeps the docs portable and matches typical workflows:-# Standard user -docker-compose -f "${HOME}/source/devshell-dsc/docker-compose.yml" run --rm dev - -# Root user -docker-compose -f "${HOME}/source/devshell-dsc/docker-compose.yml" run --rm --user root dev +# Standard user +docker compose -f "$(pwd)/docker-compose.yml" run --rm dev + +# Root user +docker compose -f "$(pwd)/docker-compose.yml" run --rm --user root dev(Also switches to the Compose v2
docker composeCLI, which is now the default.)
Please update the surrounding note so it no longer asks users to “change the above path”.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (4)
.github/workflows/docker-publish.yml(1 hunks)CONTRIBUTING.md(1 hunks)README.md(1 hunks)cspell.json(1 hunks)
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[grammar] ~1-~1: Use correct spacing
Context: # Contributing to devshell-dsc Thank you for your interest in contribut...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~3-~3: Use correct spacing
Context: ... run, and rebuild the development shell locally. For any additional contributions, bug re...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~5-~5: Use correct spacing
Context: ... an issue or pull request on the GitHub repository. ## Prerequisites - Docker installed on you...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~9-~9: Use modal and auxiliary verbs correctly
Context: ...GitHub repository. ## Prerequisites - Docker installed on your system. ## Running a...
(QB_NEW_EN_OTHER_ERROR_IDS_24)
[grammar] ~9-~9: Use correct spacing
Context: ...erequisites - Docker installed on your system. ## Running and Testing the DevShell Contain...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~11-~11: Use correct spacing
Context: ...m. ## Running and Testing the DevShell Container To launch the development shell, run the...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~13-~13: There might be a mistake here.
Context: ...hell, run the following command in your terminal: ### Using Docker To launch the container a...
(QB_NEW_EN_OTHER)
[grammar] ~15-~15: Use correct spacing
Context: ...ng command in your terminal: ### Using Docker To launch the container and log in as _r...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~17-~17: There might be a mistake here.
Context: ... To launch the container and log in as root: sh docker run --rm -it devshell:dsc ### Using Docker Compose To launch the...
(QB_NEW_EN_OTHER)
[grammar] ~23-~23: Use correct spacing
Context: ... -it devshell:dsc ``` ### Using Docker Compose To launch the container as developer...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~25-~25: There might be a mistake here.
Context: ...r** with your current folder mounted at /home/developer/work: sh docker-compose run --rm dev ## Rebuilding the Container ### Docke...
(QB_NEW_EN_OTHER)
[grammar] ~31-~31: Use correct spacing
Context: ...ose run --rm dev ## Rebuilding the Container ### Docker sh docker build -t devshell:d...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~39-~39: Use correct spacing
Context: ...build -t devshell:dsc . ### Docker Compose sh docker-compose build dev ### Docker (No Cache) sh docker build --...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~45-~45: Use correct spacing
Context: ...r-compose build dev ### Docker (No Cache) sh docker build --no-cache -t devshell:dsc . ### Docker Compose (No Cache) sh docker-...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~51-~51: Use correct spacing
Context: ...shell:dsc . ### Docker Compose (No Cache) sh docker-compose build --no-cache dev ``` ## Publishing Publishing happens automatic...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~59-~59: Use correct spacing
Context: ...ic versioning in the format v1.0.0 is created. ### Build Build the latest tag: ```sh do...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~63-~63: There might be a mistake here.
Context: ...created. ### Build Build the latest tag: sh docker build -t viscalyx/devshell-dsc:latest . ### Publish to Docker Hub ```sh op ite...
(QB_NEW_EN_OTHER)
[grammar] ~69-~69: There might be a problem here.
Context: ...dsc:latest . ### Publish to Docker Hub sh op item get "" --field password --reveal | docker login --username viscalyx --password-stdin docker push viscalyx/devshell-dsc:latest Logout from Docker Hub: sh docker logout `...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~76-~76: There might be a mistake here.
Context: ...hell-dsc:latest Logout from Docker Hub: sh docker logout ``` ### Publish to GitHub Container Registr...
(QB_NEW_EN_OTHER)
[grammar] ~82-~82: Use correct spacing
Context: ...ut ``` ### Publish to GitHub Container Registry Required GitHub Token permissions: - ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~84-~84: There might be a mistake here.
Context: ...ainer Registry Required GitHub Token permissions: - Packages: Read & write - Packages...
(QB_NEW_EN_OTHER)
[grammar] ~88-~88: Use correct spacing
Context: ... a private repo) Repository: Read & write >[!IMPORTANT] >Currently only GitHub clas...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~91-~91: Make sure to use plural and singular nouns correctly
Context: ...tly only GitHub classic Personal Access Token works, not fine-grained Personal Access Token...
(QB_NEW_EN_OTHER_ERROR_IDS_10)
[grammar] ~91-~91: Use correct spacing
Context: ...works, not fine-grained Personal Access Tokens. Tag the image for GHCR: ```sh docker ta...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~93-~93: There might be a mistake here.
Context: ...sonal Access Tokens. Tag the image for GHCR: sh docker tag viscalyx/devshell-dsc:latest ghcr.io/viscalyx/devshell-dsc:latest Login to GHCR and push: ```sh op i...
(QB_NEW_EN_OTHER)
[grammar] ~98-~98: Use the right verb tense
Context: ...cr.io/viscalyx/devshell-dsc:latest Login to GHCR and push: sh op item get "<...
(QB_NEW_EN_OTHER_ERROR_IDS_13)
[grammar] ~99-~99: There might be a mistake here.
Context: ...shell-dsc:latest Login to GHCR and push: sh op item get "" --field password --reveal | docker login ghcr.io -u viscalyxbot --password-stdin docker push ghcr.io/viscalyx/devshell-dsc:latest Logout from GHCR: sh docker lo...
(QB_NEW_EN_OTHER)
[grammar] ~106-~106: There might be a mistake here.
Context: ...yx/devshell-dsc:latest Logout from GHCR: sh docker logout ghcr.io ``` ### Make GHCR Package Public Once push...
(QB_NEW_EN_OTHER)
[grammar] ~112-~112: Use correct spacing
Context: ...gout ghcr.io ``` ### Make GHCR Package Public Once pushed, GHCR packages default to pr...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~114-~114: There might be a mistake here.
Context: ...ckages default to private. To switch to public: - Via GitHub UI: Go to your GitHub acco...
(QB_NEW_EN_OTHER)
[grammar] ~116-~116: Use correct spacing
Context: ...devshell-dsc`, and change visibility to Public. - Via API (classic PAT or GH_TOKEN with ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~118-~118: Use correct spacing
Context: ... PAT or GH_TOKEN with packages:read & packages:write): sh curl -X PUT \ -H "Authorization: token $GITHUB_TOKEN" \ -H "Accept: application/vnd.github.v3+json" \ https://api.github.com/user/packages/container/devshell-dsc/visibility \ -d '{"visibility":"public"}' - Via GitHub CLI: ```sh gh api -X PUT /...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~128-~128: There might be a mistake here.
Context: ...ibility":"public"}' - **Via GitHub CLI**: sh gh api -X PUT /user/packages/container/devshell-dsc/visibility -F visibility=public ```
(QB_NEW_EN_OTHER)
README.md
[grammar] ~1-~1: Use correct spacing
Context: # DevShell DSC Container Dockerized Ubuntu 24.04 dev environment ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~3-~3: Use correct spacing
Context: ...3 pre-configured for seamless developer workflows. ## Included Tools - PowerShell 7.5.2 & DSC...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~5-~5: Use correct spacing
Context: ...mless developer workflows. ## Included Tools - PowerShell 7.5.2 & DSC v3 support - .NET...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~13-~13: Use correct spacing
Context: ...do - Zsh & Oh My Zsh - Health check via PowerShell ## Prerequisites Ensure the following are ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~17-~17: Use correct spacing
Context: ...he following are installed on your host system: - Docker (version >= 28.2) - Docker Compos...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~20-~20: Use correct spacing
Context: ...n >= 28.2) - Docker Compose (version >= 2.36) ## Quick Start Launch an interactive devel...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~22-~22: Use correct spacing
Context: ...ker Compose (version >= 2.36) ## Quick Start Launch an interactive development shell ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~24-~24: Use correct spacing
Context: ...pment shell with your project directory mounted: >[!NOTE] >The container will mount the di...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~27-~27: Use correct spacing
Context: ... directory you run this command from to /home/developer/work. bash # Standard user docker-compose -f "${HOME}/source/devshell-dsc/docker-compose.yml" run --rm dev # Root user docker-compose -f "${HOME}/source/devshell-dsc/docker-compose.yml" run --rm --user root dev >[!IMPORTANT] > Change the above path to ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
…pose' for consistency
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
README.md (1)
52-58: Hard-coded compose path negates the “dynamic folder” goal
Use a repo-relative compose file so the command works regardless of where the repo is cloned.-docker compose -f "${HOME}/source/devshell-dsc/docker-compose.yml" run --rm dev +docker compose -f ./docker-compose.yml run --rm devApply the same change to the root-user example below.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (5)
.github/workflows/docker-publish.yml(1 hunks)CONTRIBUTING.md(1 hunks)Dockerfile(1 hunks)README.md(1 hunks)cspell.json(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~1-~1: Use correct spacing
Context: # DevShell DSC Container Dockerized Ubuntu 24.04 dev environment ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~3-~3: Use correct spacing
Context: ...3 pre-configured for seamless developer workflows. ## Included Tools - PowerShell 7.5.2 & DSC...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~5-~5: Use correct spacing
Context: ...mless developer workflows. ## Included Tools - PowerShell 7.5.2 & DSC v3 support - .NET...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~13-~13: Use correct spacing
Context: ...do - Zsh & Oh My Zsh - Health check via PowerShell ## Prerequisites Ensure the following are ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~17-~17: Use correct spacing
Context: ...he following are installed on your host system: - Docker (version >= 28.2) - Docker Compos...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~20-~20: Use correct spacing
Context: ...n >= 28.2) - Docker Compose (version >= 2.36) ## Quick Start Launch an interactive devel...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~22-~22: Use correct spacing
Context: ...ker Compose (version >= 2.36) ## Quick Start Launch an interactive development shell ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~24-~24: Use correct spacing
Context: ...pment shell with your project directory mounted: ## Pull and Run from Docker Hub Use the pu...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~26-~26: Use correct spacing
Context: ...y mounted: ## Pull and Run from Docker Hub Use the published image from any local f...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~28-~28: Use correct spacing
Context: ... running it with your current directory mounted: bash # Pull the latest image docker pull viscalyx/devshell-dsc:latest # Run interactively, mounting current directory to /home/developer/work docker run --rm -it \ -v "$(pwd)":/home/developer/work \ viscalyx/devshell-dsc:latest ## Clone GitHub repository Clone the repos...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~40-~40: There might be a mistake here.
Context: ...evshell-dsc:latest ## Clone GitHub repository Clone the repository via SSH: bash g...
(QB_NEW_EN_OTHER)
[grammar] ~42-~42: Use correct spacing
Context: ...ub repository Clone the repository via SSH: bash git clone git@github.com:viscalyx/devshell-dsc.git cd devshell-dsc >[!NOTE] >The container will mount the di...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~50-~50: Use correct spacing
Context: ... directory you run this command from to /home/developer/work. bash # Standard user docker compose -f "${HOME}/source/devshell-dsc/docker-compose.yml" run --rm dev # Root users docker compose -f "${HOME}/source/devshell-dsc/docker-compose.yml" run --rm --user root dev >[!IMPORTANT] > Change the above path to ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
CONTRIBUTING.md
[grammar] ~1-~1: Use correct spacing
Context: # Contributing to devshell-dsc Thank you for your interest in contribut...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~3-~3: Use correct spacing
Context: ... run, and rebuild the development shell locally. For any additional contributions, bug re...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~5-~5: Use correct spacing
Context: ... an issue or pull request on the GitHub repository. ## Prerequisites - Docker installed on you...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~9-~9: Use modal and auxiliary verbs correctly
Context: ...GitHub repository. ## Prerequisites - Docker installed on your system. ## Running a...
(QB_NEW_EN_OTHER_ERROR_IDS_24)
[grammar] ~9-~9: Use correct spacing
Context: ...erequisites - Docker installed on your system. ## Running and Testing the DevShell Contain...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~11-~11: Use correct spacing
Context: ...m. ## Running and Testing the DevShell Container To launch the development shell, run the...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~13-~13: There might be a mistake here.
Context: ...hell, run the following command in your terminal: ### Using Docker To launch the container a...
(QB_NEW_EN_OTHER)
[grammar] ~15-~15: Use correct spacing
Context: ...ng command in your terminal: ### Using Docker To launch the container and log in as _r...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~17-~17: There might be a mistake here.
Context: ... To launch the container and log in as root: sh docker run --rm -it devshell:dsc ### Using Docker Compose To launch the...
(QB_NEW_EN_OTHER)
[grammar] ~23-~23: Use correct spacing
Context: ... -it devshell:dsc ``` ### Using Docker Compose To launch the container as developer...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~25-~25: There might be a mistake here.
Context: ...r** with your current folder mounted at /home/developer/work: sh docker compose run --rm dev ## Rebuilding the Container ### Docke...
(QB_NEW_EN_OTHER)
[grammar] ~31-~31: Use correct spacing
Context: ...ose run --rm dev ## Rebuilding the Container ### Docker sh docker build -t devshell:d...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~39-~39: Use correct spacing
Context: ...build -t devshell:dsc . ### Docker Compose sh docker compose build dev ### Docker (No Cache) sh docker build --...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~45-~45: Use correct spacing
Context: ...r compose build dev ### Docker (No Cache) sh docker build --no-cache -t devshell:dsc . ### Docker Compose (No Cache) sh docker ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~51-~51: Use correct spacing
Context: ...shell:dsc . ### Docker Compose (No Cache) sh docker compose build --no-cache dev ``` ## Publishing Publishing happens automatic...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~59-~59: Use correct spacing
Context: ...ic versioning in the format v1.0.0 is created. ### Build Build the latest tag: ```sh do...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~63-~63: There might be a mistake here.
Context: ...created. ### Build Build the latest tag: sh docker build -t viscalyx/devshell-dsc:latest . ### Publish to Docker Hub ```sh op ite...
(QB_NEW_EN_OTHER)
[grammar] ~69-~69: There might be a problem here.
Context: ...dsc:latest . ### Publish to Docker Hub sh op item get "" --field password --reveal | docker login --username viscalyx --password-stdin docker push viscalyx/devshell-dsc:latest Logout from Docker Hub: sh docker logout `...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~76-~76: There might be a mistake here.
Context: ...hell-dsc:latest Logout from Docker Hub: sh docker logout ``` ### Publish to GitHub Container Registr...
(QB_NEW_EN_OTHER)
[grammar] ~82-~82: Use correct spacing
Context: ...ut ``` ### Publish to GitHub Container Registry Required GitHub Token permissions: - ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~84-~84: There might be a mistake here.
Context: ...ainer Registry Required GitHub Token permissions: - Packages: Read & write - Packages...
(QB_NEW_EN_OTHER)
[grammar] ~88-~88: Use correct spacing
Context: ... a private repo) Repository: Read & write >[!IMPORTANT] >Currently only GitHub clas...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~91-~91: Make sure to use plural and singular nouns correctly
Context: ...tly only GitHub classic Personal Access Token works, not fine-grained Personal Access Token...
(QB_NEW_EN_OTHER_ERROR_IDS_10)
[grammar] ~91-~91: Use correct spacing
Context: ...works, not fine-grained Personal Access Tokens. Tag the image for GHCR: ```sh docker ta...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~93-~93: There might be a mistake here.
Context: ...sonal Access Tokens. Tag the image for GHCR: sh docker tag viscalyx/devshell-dsc:latest ghcr.io/viscalyx/devshell-dsc:latest Login to GHCR and push: ```sh op i...
(QB_NEW_EN_OTHER)
[grammar] ~98-~98: Use the right verb tense
Context: ...cr.io/viscalyx/devshell-dsc:latest Login to GHCR and push: sh op item get "<...
(QB_NEW_EN_OTHER_ERROR_IDS_13)
[grammar] ~99-~99: There might be a mistake here.
Context: ...shell-dsc:latest Login to GHCR and push: sh op item get "" --field password --reveal | docker login ghcr.io -u viscalyxbot --password-stdin docker push ghcr.io/viscalyx/devshell-dsc:latest Logout from GHCR: sh docker lo...
(QB_NEW_EN_OTHER)
[grammar] ~106-~106: There might be a mistake here.
Context: ...yx/devshell-dsc:latest Logout from GHCR: sh docker logout ghcr.io ``` ### Make GHCR Package Public Once push...
(QB_NEW_EN_OTHER)
[grammar] ~112-~112: Use correct spacing
Context: ...gout ghcr.io ``` ### Make GHCR Package Public Once pushed, GHCR packages default to pr...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~114-~114: There might be a mistake here.
Context: ...ckages default to private. To switch to public: - Via GitHub UI: Go to your GitHub acco...
(QB_NEW_EN_OTHER)
[grammar] ~116-~116: Use correct spacing
Context: ...devshell-dsc`, and change visibility to Public. - Via API (classic PAT or GH_TOKEN with ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~118-~118: Use correct spacing
Context: ... PAT or GH_TOKEN with packages:read & packages:write): sh curl -X PUT \ -H "Authorization: token $GITHUB_TOKEN" \ -H "Accept: application/vnd.github.v3+json" \ https://api.github.com/user/packages/container/devshell-dsc/visibility \ -d '{"visibility":"public"}' - Via GitHub CLI: ```sh gh api -X PUT /...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~128-~128: There might be a mistake here.
Context: ...ibility":"public"}' - **Via GitHub CLI**: sh gh api -X PUT /user/packages/container/devshell-dsc/visibility -F visibility=public ```
(QB_NEW_EN_OTHER)
🪛 actionlint (1.7.7)
.github/workflows/docker-publish.yml
46-46: could not parse as YAML: yaml: line 46: mapping values are not allowed in this context
(syntax-check)
🪛 YAMLlint (1.37.1)
.github/workflows/docker-publish.yml
[warning] 3-3: truthy value should be one of [false, true]
(truthy)
[error] 46-46: syntax error: mapping values are not allowed here
(syntax)
🔇 Additional comments (2)
cspell.json (1)
7-21: Lower-casing & new terms look goodThe dictionary is now consistently lower-case and the added Docker terms avoid future false positives.
No issues spotted.CONTRIBUTING.md (1)
71-74: Preferdocker logoutwithout arguments
docker logoutalready logs out of the current registry context; specifying the host is unnecessary and sometimes confuses older Docker versions.-docker logout ghcr.io +docker logoutLikely an incorrect or invalid review comment.
…ion in Docker publish workflow
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/docker-publish.yml(1 hunks)
🔇 Additional comments (4)
.github/workflows/docker-publish.yml (4)
1-8: Consider whether pre-release tags should also trigger the workflowThe pattern
'v*.*.*'matches only plain semantic versions likev1.2.3.
If you ever cut candidates (v1.2.3-rc1,v1.2.3-beta.2, etc.) they won’t publish automatically.
Adjust the glob (e.g.'v*.*.**') or add a separate pattern if pre-releases should be handled.
11-15: Minimal permission set looks good
contents: read+packages: writeis the smallest set needed for the steps below—nice job keeping the token surface tight.
No action needed.
20-26: 👍 Actions bumped to Node-20–compatible majorsMoving to
@v4/@v3majors eliminates the looming deprecation warned about in the last review.
Thanks for addressing that.
46-47: Good catch quoting the cache stringsQuoting avoids the YAML parser issue flagged previously—issue resolved.
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
This change is