Skip to content

Scripts refactor after migration from CircleCI#879

Merged
3alpha merged 1 commit intomainfrom
scripts-refactor
Oct 23, 2025
Merged

Scripts refactor after migration from CircleCI#879
3alpha merged 1 commit intomainfrom
scripts-refactor

Conversation

@3alpha
Copy link
Copy Markdown
Collaborator

@3alpha 3alpha commented Oct 20, 2025

Usage related changes

Development related changes

Resolves #878.

Checklist:

  • Checked out the contribution guidelines
  • Applied formatting - ./scripts/format.sh
  • No linter errors - ./scripts/clippy_check.sh
  • No unused dependencies - ./scripts/check_unused_deps.sh
  • No spelling errors - ./scripts/check_spelling.sh
  • Performed code self-review
  • Rebased to the latest commit of the target branch (or merged it into my branch)
    • Once you make the PR reviewable, please avoid force-pushing
  • Updated the docs if needed - ./website/README.md
  • Linked the issues resolvable by this PR - linking info
  • Updated the tests if needed; all passing - execution info

Summary by CodeRabbit

  • Chores
    • Simplified CI/CD automation by removing build and deployment scripts.
    • Updated Docker build configuration with new image references.
    • Removed unused build dependencies from project requirements.
    • Updated release process documentation to include cross-project adaptation guidance.
    • Refined documentation build configuration to exclude version-controlled documentation files from formatting.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Oct 20, 2025

Walkthrough

This pull request removes legacy CI/CD automation scripts and infrastructure dependencies following previous changes. Deleted files include CircleCI cache management, Docker image building and tagging, binary compilation, CI artifact fetching, and Foundry installation scripts. The GitHub Actions workflow is updated with corrected Dockerfile paths and simplified documentation deployment logic. Release documentation is refactored to focus on manual adaptation steps rather than CI-driven processes. Python dependencies and obsolete shell utilities are removed, while documentation ignore patterns are expanded.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

The changes involve multiple file deletions and configuration updates spanning CI/CD infrastructure, Docker workflows, build processes, and documentation systems. While individual modifications are straightforward (primarily removals and path updates), the breadth across interconnected systems and need to verify no critical workflows are inadvertently broken requires moderate assessment effort. The homogeneous nature of deletions reduces complexity, but the diversity of affected domains offsets this.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (4 passed)
Check name Status Explanation
Title Check ✅ Passed The pull request title "Scripts refactor after migration from CircleCI" accurately and concisely captures the primary change in the changeset. The PR demonstrates a clear pattern of removing obsolete scripts and configurations that are no longer needed after the CI system migration (scripts/cache.sh, docker/image_build.sh, docker/tag_images_and_create_joint_image_manifests.sh, and several others), along with updating workflow files and documentation to reflect the new setup. The title is specific, clear, and allows a reviewer quickly scanning history to understand the main objective without ambiguity.
Linked Issues Check ✅ Passed The PR directly addresses issue #878 ("Clean up old scripts") by removing multiple obsolete scripts and folder structures that became unnecessary after the CircleCI migration. The deletions include CircleCI-specific cache management scripts (.circleci/scripts/cache.sh), Docker image building scripts (docker/image_build.sh, docker/tag_images_and_create_joint_image_manifests.sh), and CI-related helper scripts (scripts/compile_binary.sh, scripts/fetch_ci_binaries.py, scripts/install_foundry.sh). The PR also updates related workflows and documentation (RELEASE.md, .github/workflows/build-and-publish.yml, scripts/publish_docs.sh) to reflect the post-migration state, and removes outdated dependencies from scripts/requirements.txt, fully satisfying the cleanup objective.
Out of Scope Changes Check ✅ Passed The overwhelming majority of changes are directly related to the issue objective of cleaning up scripts and infrastructure after the CircleCI migration. However, there is one minor out-of-scope addition: the website/.prettierignore file has two new ignore patterns added (versioned_docs/** and versioned_sidebars/**), which is a formatting/configuration improvement unrelated to the core cleanup objective. This is an extremely minor change that does not detract from the primary PR purpose and could reasonably be considered general maintenance during the refactor process.
Description Check ✅ Passed The PR description follows the required template structure with sections for "Usage related changes," "Development related changes," and a comprehensive checklist. While the usage-related section contains no narrative content, the development section provides the key reference "Resolves #878" which links to the cleanup objective. All checklist items are marked complete, indicating the author followed the contribution guidelines, performed necessary quality checks, and completed documentation updates. The sparse narrative is somewhat compensated by the explicit issue linkage and thorough checklist completion.
✨ Finishing touches
  • 📝 Docstrings were successfully generated.
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch scripts-refactor

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 60d8b29 and e24df42.

📒 Files selected for processing (11)
  • .circleci/scripts/cache.sh (0 hunks)
  • .github/workflows/build-and-publish.yml (3 hunks)
  • RELEASE.md (1 hunks)
  • docker/image_build.sh (0 hunks)
  • docker/tag_images_and_create_joint_image_manifests.sh (0 hunks)
  • scripts/compile_binary.sh (0 hunks)
  • scripts/fetch_ci_binaries.py (0 hunks)
  • scripts/install_foundry.sh (0 hunks)
  • scripts/publish_docs.sh (0 hunks)
  • scripts/requirements.txt (0 hunks)
  • website/.prettierignore (1 hunks)
💤 Files with no reviewable changes (8)
  • .circleci/scripts/cache.sh
  • scripts/compile_binary.sh
  • scripts/fetch_ci_binaries.py
  • scripts/requirements.txt
  • scripts/install_foundry.sh
  • scripts/publish_docs.sh
  • docker/image_build.sh
  • docker/tag_images_and_create_joint_image_manifests.sh
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Build and Test
🔇 Additional comments (4)
website/.prettierignore (1)

3-4: Good alignment with documentation refactoring.

The new ignore patterns appropriately exclude versioned documentation artifacts from Prettier formatting, which aligns with the updated documentation versioning workflow.

.github/workflows/build-and-publish.yml (2)

349-349: Minor cleanup: GIT_PASS environment variable.

The change to use ${{ secrets.GITHUB_TOKEN }} directly is a good simplification. Verify that the documentation deployment (npm run deploy with USE_SSH="true") continues to work as expected with this credential.


261-261: No issues found. Dockerfile and seed0.Dockerfile both exist at the repository root.

Verification confirms that both ./Dockerfile and ./seed0.Dockerfile are present at the repository root, where the workflow references them. The path changes from ./docker/Dockerfile and ./docker/seed0.Dockerfile are valid and will not cause build failures.

RELEASE.md (1)

17-17: Release documentation reflects shift to manual adaptation tasks.

The updated release steps align with the broader PR objective of moving away from CI-driven automation. The instructions now direct maintainers to adapt external projects (starknet-devnet-js, starknet-foundry) manually with reference to prior work, replacing prior steps that described CI publishing and artifact handling. This is consistent with the removal of legacy CI scripts.

Also applies to: 19-19


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.

@3alpha
Copy link
Copy Markdown
Collaborator Author

3alpha commented Oct 23, 2025

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Oct 23, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Oct 23, 2025

Caution

Docstrings generation - FAILED

No docstrings were generated.

@3alpha 3alpha merged commit 22ea948 into main Oct 23, 2025
2 checks passed
@3alpha 3alpha deleted the scripts-refactor branch October 23, 2025 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clean up old scripts

1 participant