Update links to readme files and others for mono repo - #8827
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughUpdates CrafterCMS repository links across issue templates, documentation, package metadata, changelog entries, and inline references. The root README also revises cloning, module forking, upgrade, and build instructions. ChangesRepository reference updates
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![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
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
studio-ui/ui/uppy/package.json (1)
18-23: 🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick winAlign the repository metadata with the monorepo.
bugs.urlnow targetscraftersoftware/craftercms, butrepository.urlandrepository.directorystill reference the former standalonestudio-uilayout. Update both fields so package consumers are directed to the correct monorepo location.Proposed fix
"repository": { "type": "git", - "url": "git+https://github.com/craftercms/studio-ui.git", - "directory": "ui/uppy" + "url": "git+https://github.com/craftersoftware/craftercms.git", + "directory": "studio-ui/ui/uppy" },🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@studio-ui/ui/uppy/package.json` around lines 18 - 23, Update the repository metadata in package.json to point to the Crafter CMS monorepo: replace the former studio-ui repository URL and adjust repository.directory to the package’s correct monorepo path, keeping bugs.url unchanged.
🧹 Nitpick comments (1)
studio/README.md (1)
12-12: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winUse the configured heading style for the new subsections.
The new headings at Lines 12, 16, and 20 trigger markdownlint MD003 because this repository expects setext headings. Convert them to setext style or update the lint configuration consistently.
Also applies to: 16-16, 20-20
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@studio/README.md` at line 12, Update the new subsection headings in studio/README.md, including Code of Conduct and the headings at the corresponding lines, to use the repository’s configured setext heading style; alternatively, consistently update the markdownlint MD003 configuration if that is the intended project-wide change.Source: Linters/SAST tools
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@groovy-sandbox/README.md`:
- Line 54: Align the changed community headings with the configured markdownlint
MD003 style by converting the headings to setext syntax, preserving their
existing text. Apply this to groovy-sandbox/README.md at lines 54, 58, and 62;
profile/README.md at lines 12, 16, and 20; search/README.md at lines 12, 16, and
20; and social/README.md at lines 12, 16, and 20. Do not change the
configuration unless ATX headings are intentionally required.
In `@README.md`:
- Around line 224-242: Update the README section “4.3.1. Forking the Repository”
so the documented selfUpdate command explicitly uses the upstream remote via the
gitRemote Gradle property. Also update the fallback git pull instruction to pull
from upstream, ensuring both update paths retrieve changes from the canonical
repository rather than the contributor’s fork.
---
Outside diff comments:
In `@studio-ui/ui/uppy/package.json`:
- Around line 18-23: Update the repository metadata in package.json to point to
the Crafter CMS monorepo: replace the former studio-ui repository URL and adjust
repository.directory to the package’s correct monorepo path, keeping bugs.url
unchanged.
---
Nitpick comments:
In `@studio/README.md`:
- Line 12: Update the new subsection headings in studio/README.md, including
Code of Conduct and the headings at the corresponding lines, to use the
repository’s configured setext heading style; alternatively, consistently update
the markdownlint MD003 configuration if that is the intended project-wide
change.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 5a855d91-da5b-4a22-ad0d-dd100fdf6aee
📒 Files selected for processing (40)
.github/ISSUE_TEMPLATE/bug_report.yml.github/ISSUE_TEMPLATE/enhancement_request.yml.github/ISSUE_TEMPLATE/feature_request.yml.github/ISSUE_TEMPLATE/quality_request.ymlREADME.mdbuild.gradlecli/README.mdcommons/README.mdcore/README.mddeployer/README.mdengine/README.mdgroovy-sandbox/README.mdjs-sdk/CHANGELOG.mdjs-sdk/README.mdjs-sdk/package.jsonjs-sdk/packages/classes/package.jsonjs-sdk/packages/content/README.mdjs-sdk/packages/content/package.jsonjs-sdk/packages/ice/package.jsonjs-sdk/packages/models/package.jsonjs-sdk/packages/redux/package.jsonjs-sdk/packages/search/package.jsonjs-sdk/packages/utils/package.jsonprofile/README.mdsearch/README.mdsocial/README.mdstudio-ui/README.mdstudio-ui/ui/app/README.mdstudio-ui/ui/app/scripts/README.mdstudio-ui/ui/app/src/components/DashletCard/dashletCommons.tsxstudio-ui/ui/app/src/components/ItemDisplay/ItemDisplay.tsxstudio-ui/ui/app/src/components/ItemMegaMenu/ItemMegaMenuUI.tsxstudio-ui/ui/app/src/components/PathNavigator/PathNavigator.tsxstudio-ui/ui/app/src/components/PathNavigator/PathNavigatorUI.tsxstudio-ui/ui/app/src/components/PathNavigatorTree/PathNavigatorTree.tsxstudio-ui/ui/app/src/components/PathNavigatorTree/PathNavigatorTreeUI.tsxstudio-ui/ui/app/src/utils/contentType.tsstudio-ui/ui/guest/src/controls/rte.tsstudio-ui/ui/uppy/package.jsonstudio/README.md
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
224-236: 🎯 Functional Correctness | 🟠 MajorMake the documented self-update pull from
upstream.The instructions configure
originas the fork and add the canonical repository asupstream, but Line [235] runs./gradlew selfUpdatewithout-PgitRemote=upstream. SincegitRemotedefaults tooriginandbuild.gradlepasses it togit pull, this can update from the fork instead of the canonical repository.Suggested documentation change
- ./gradlew selfUpdate + ./gradlew -PgitRemote=upstream selfUpdate🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` around lines 224 - 236, Update the “To update your local clone with the latest” command in the Forking the Repository section to invoke selfUpdate with the gitRemote property set to upstream, ensuring it pulls from the canonical repository rather than origin.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@README.md`:
- Around line 224-236: Update the “To update your local clone with the latest”
command in the Forking the Repository section to invoke selfUpdate with the
gitRemote property set to upstream, ensuring it pulls from the canonical
repository rather than origin.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: ba6580b9-f38c-4646-b3f6-477e38b61309
📒 Files selected for processing (2)
README.mdbuild.gradle
3 participants
Ticket reference or the full description of what's in the PR
Update links to readme files and others for mono repo
Summary by CodeRabbit