Skip to content

Conversation

@LesnyRumcajs
Copy link
Member

@LesnyRumcajs LesnyRumcajs commented Jan 13, 2026

Summary of changes

Changes introduced in this pull request:

  • get rid of Makefile in docs/ in favour of the powerful mise

Reference issue to close (if applicable)

Closes

Other information and links

Change checklist

  • I have performed a self-review of my own code,
  • I have made corresponding changes to the documentation. All new code adheres to the team's documentation standards,
  • I have added tests that prove my fix is effective or that my feature works (if possible),
  • I have made sure the CHANGELOG is up-to-date. All user-facing changes should be reflected in this document.

Summary by CodeRabbit

  • Chores
    • Consolidated build workflow configuration to streamline CI/CD pipeline execution
    • Unified spellcheck dictionary formatting and validation processes through a centralized task system
    • Optimized documentation checking procedures for improved efficiency in the build process

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 13, 2026

Walkthrough

Migrates spellcheck dictionary formatting tasks from Makefile to mise.toml configuration. Updates CI workflow to use mise action instead of explicit Node.js setup, eliminating standalone Node.js configuration steps while maintaining task execution through the mise runner.

Changes

Cohort / File(s) Summary
CI/CD Workflow Configuration
.github/workflows/docs-check.yml
Replaces explicit Node.js setup (setup-node, caching) with jdx/mise-action; invokes mise run for dictionary check task; adds yarn format-check and yarn build steps. Net change: +2/-6 lines.
Build Task Migration
docs/Makefile
Removes SPELLCHECK_DICTIONARY variable and two related targets (format-spellcheck-dictionary, format-spellcheck-dictionary-check) that handled sorting and validation of dictionary.txt. Net change: +0/-9 lines.
Task Configuration
mise.toml
Adds two new tasks under [tasks] section: docs:format-spellcheck-dictionary (sorts and deduplicates dictionary.txt) and docs:format-spellcheck-dictionary-check (validates formatting via diff). Net change: +19/-0 lines.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Suggested reviewers

  • akaladarshi
  • hanabi1224
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'chore: makefile to mise in docs/' clearly describes the main change: migrating from Makefile to mise tool in the docs directory, which is the primary objective of the PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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


📜 Recent review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2c87fa1 and b4ccd39.

📒 Files selected for processing (3)
  • .github/workflows/docs-check.yml
  • docs/Makefile
  • mise.toml
💤 Files with no reviewable changes (1)
  • docs/Makefile
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: LesnyRumcajs
Repo: ChainSafe/forest PR: 5907
File: src/rpc/methods/state.rs:523-570
Timestamp: 2025-08-06T15:44:33.467Z
Learning: LesnyRumcajs prefers to rely on BufWriter's Drop implementation for automatic flushing rather than explicit flush() calls in Forest codebase.
📚 Learning: 2025-10-17T09:36:15.757Z
Learnt from: elmattic
Repo: ChainSafe/forest PR: 6128
File: src/ipld/util.rs:23-30
Timestamp: 2025-10-17T09:36:15.757Z
Learning: Always run `cargo check` or `cargo build` to verify actual compilation errors in the Forest codebase before flagging them as issues. Do not rely solely on documentation or assumptions about trait implementations.

Applied to files:

  • mise.toml
📚 Learning: 2025-08-07T13:39:29.732Z
Learnt from: hanabi1224
Repo: ChainSafe/forest PR: 5886
File: interop-tests/src/tests/go_app/gen.go:58-58
Timestamp: 2025-08-07T13:39:29.732Z
Learning: In the Forest project, auto-generated files (like those generated by rust2go tool) should be skipped during code review as they are not meant to be manually edited.

Applied to files:

  • mise.toml
⏰ 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). (8)
  • GitHub Check: Coverage
  • GitHub Check: tests-release
  • GitHub Check: Build forest binaries on Linux AMD64
  • GitHub Check: Build MacOS
  • GitHub Check: cargo-publish-dry-run
  • GitHub Check: Build Ubuntu
  • GitHub Check: All lint checks
  • GitHub Check: rubocop
🔇 Additional comments (4)
mise.toml (2)

173-180: LGTM!

The dictionary formatting task is straightforward and correct. The dir = "docs" directive properly sets the working directory.

Minor note: The temp file won't be cleaned up if the script fails before mv, but this is a low-risk edge case for a formatting task.


182-190: LGTM!

The check task correctly validates dictionary formatting with proper cleanup via trap. The diff will exit non-zero if the file isn't properly sorted/deduplicated, which is the expected behavior for a CI check.

.github/workflows/docs-check.yml (2)

34-35: LGTM!

The mise-action setup and task invocation look correct. The dir = "docs" in the task definition is relative to the project root (where mise.toml lives), so it will correctly execute in the docs/ directory regardless of the workflow's working-directory default.


36-40: LGTM!

The yarn-based steps continue to work correctly with the ./docs working directory default, maintaining the existing build and validation pipeline.


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

@LesnyRumcajs LesnyRumcajs added this pull request to the merge queue Jan 13, 2026
Merged via the queue into main with commit c9a5b64 Jan 13, 2026
54 of 55 checks passed
@LesnyRumcajs LesnyRumcajs deleted the evict-docs-makefile branch January 13, 2026 19:12
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.

3 participants