Skip to content

Migrate project template to v1.2.0#129

Merged
Sewer56 merged 6 commits into
mainfrom
migrate/v1.2.0
Jun 6, 2026
Merged

Migrate project template to v1.2.0#129
Sewer56 merged 6 commits into
mainfrom
migrate/v1.2.0

Conversation

@Sewer56

@Sewer56 Sewer56 commented Jun 6, 2026

Copy link
Copy Markdown
Member

Moves docs/ into src/docs/ per migration guide. Updates deploy-mkdocs.yml and template-version.

Sewer56 added 6 commits June 6, 2026 18:04
- Add publish dry-run step to verify.sh and verify.ps1
- Bump template-version.txt from 1.1.1 to 1.1.2
- Improve verify.sh / verify.ps1 with root-switching, error aggregation,
  RUSTDOCFLAGS restore, and non-zero exit on failure
- Add .vscode/settings.json to disable YAML format-on-save
- Add crates.io keywords/categories placeholders to all Cargo.toml files
- Fix panic = abort comment wording
- Update template version marker to 1.1.3
- Rename `format` job to `format-check`
- Add repo-relative comment headers to verify scripts
- Bump template version marker to 1.1.4
Migrate template version marker from v1.1.4 to v1.1.5 per migration docs.
@Sewer56 Sewer56 changed the title Migration to v1.2.0 Migrate project template to v1.2.0 Jun 6, 2026
@coderabbitai

coderabbitai Bot commented Jun 6, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

This PR refactors the Rust project's verification pipeline to aggregate command failures instead of aborting immediately. Both verify.ps1 and verify.sh now track failures via Register-CommandFailure (PowerShell) and run_cmd return codes (shell), recording which steps failed while allowing all checks to complete. A new cargo publish --dry-run step validates publication readiness in both scripts. CI/CD workflows are updated: the format job is renamed to format-check, MkDocs documentation paths migrate from docs/ to src/docs/, template version bumps to 1.2.0, and VS Code YAML formatting is disabled. Finally, six workspace crates receive keywords and categories metadata for improved crates.io discoverability.

Possibly related PRs

  • Reloaded-Project/ReloadedCode#35: Implements overlapping changes to verify script error handling, failure aggregation patterns, RUSTDOCFLAGS management, and cargo publish dry-run validation across both PowerShell and shell verification scripts.
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description is minimal and does not follow the provided template structure with proper explanation of changes. Expand the description to explain the changes in detail, including the migration rationale, what was moved, and why verify scripts were enhanced. Reference the contributing guidelines as mentioned in the template.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title accurately describes the primary objective of the changeset: migrating the project template to version 1.2.0.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch migrate/v1.2.0

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
.github/workflows/rust.yml (1)

144-153: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Restrict GITHUB_TOKEN permissions for format-check.

format-check only needs repository read access, but currently inherits default permissions. Tightening this reduces blast radius for third-party/action-chain compromise.

Proposed fix
   format-check:
+    permissions:
+      contents: read
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6
🤖 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 @.github/workflows/rust.yml around lines 144 - 153, The format-check job
currently inherits default GITHUB_TOKEN permissions; restrict it by adding an
explicit permissions block for the job named format-check to give only
repository read access (e.g., set contents: read) so the
actions-rust-lang/rustfmt step and actions/checkout only get minimal rights;
update the format-check job configuration (referencing the job name
"format-check" and the steps using "actions/checkout@v6" and
"actions-rust-lang/rustfmt@v1") to include the minimal permissions declaration.

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.

Outside diff comments:
In @.github/workflows/rust.yml:
- Around line 144-153: The format-check job currently inherits default
GITHUB_TOKEN permissions; restrict it by adding an explicit permissions block
for the job named format-check to give only repository read access (e.g., set
contents: read) so the actions-rust-lang/rustfmt step and actions/checkout only
get minimal rights; update the format-check job configuration (referencing the
job name "format-check" and the steps using "actions/checkout@v6" and
"actions-rust-lang/rustfmt@v1") to include the minimal permissions declaration.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 236b0e4b-f1ff-4233-b010-ffb71cfedb17

📥 Commits

Reviewing files that changed from the base of the PR and between 9b3def4 and ec63615.

📒 Files selected for processing (37)
  • .github/template-version.txt
  • .github/workflows/deploy-mkdocs.yml
  • .github/workflows/rust.yml
  • .vscode/settings.json
  • src/.cargo/verify.ps1
  • src/.cargo/verify.sh
  • src/docs/.gitignore
  • src/docs/mkdocs.yml
  • src/docs/requirements.txt
  • src/docs/src/agents.md
  • src/docs/src/architecture.md
  • src/docs/src/assets/landing.css
  • src/docs/src/comparison.md
  • src/docs/src/examples.md
  • src/docs/src/extra-sandboxing-notes.md
  • src/docs/src/feature-flags.md
  • src/docs/src/getting-started.md
  • src/docs/src/guides/custom-framework.md
  • src/docs/src/guides/custom-providers.md
  • src/docs/src/hooks.md
  • src/docs/src/index.md
  • src/docs/src/migration.md
  • src/docs/src/models-catalog.md
  • src/docs/src/sandboxing.md
  • src/docs/src/tools.md
  • src/docs/src/vendor/Reloaded/Images/Nexus-Heart-40.avif
  • src/docs/src/vendor/Reloaded/Images/Nexus-Icon-40.avif
  • src/docs/src/vendor/Reloaded/Images/Reloaded-Heart-40.avif
  • src/docs/src/vendor/Reloaded/Images/Reloaded-Icon-40.avif
  • src/docs/src/vendor/Reloaded/Stylesheets/reloaded.css
  • src/docs/start_docs.py
  • src/reloaded-code-agents/Cargo.toml
  • src/reloaded-code-bubblewrap/Cargo.toml
  • src/reloaded-code-core/Cargo.toml
  • src/reloaded-code-models-dev/Cargo.toml
  • src/reloaded-code-provider-config/Cargo.toml
  • src/reloaded-code-serdesai/Cargo.toml

@Sewer56 Sewer56 merged commit d03fa49 into main Jun 6, 2026
39 of 57 checks passed
@Sewer56 Sewer56 deleted the migrate/v1.2.0 branch June 6, 2026 17:32
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.

1 participant