Skip to content

Use setup-rust action in release workflow#164

Merged
leynos merged 1 commit intomainfrom
codex/update-release.yml-to-use-setup-rust-action
Aug 1, 2025
Merged

Use setup-rust action in release workflow#164
leynos merged 1 commit intomainfrom
codex/update-release.yml-to-use-setup-rust-action

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Aug 1, 2025

Summary

  • switch release workflow to leynos setup-rust action
  • re-export tokenize_markdown in wrap module so tests compile

Testing

  • make fmt
  • make lint
  • make test

https://chatgpt.com/codex/tasks/task_e_688bf7e0c0a08322ac64f8cccb609575

Summary by Sourcery

Switch the release workflow to the leynos setup-rust action and re-export tokenize_markdown to restore test compilation

Bug Fixes:

  • Re-export tokenize_markdown in wrap module so tests compile

CI:

  • Use leynos/setup-rust action in release workflow

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Aug 1, 2025

Reviewer's Guide

Swaps out the previous actions-rs/toolchain configuration for the leynos shared setup-rust action in the release CI workflow, and exposes the tokenize_markdown function in the wrap module to satisfy test dependencies.

Class diagram for wrap module re-exports

classDiagram
    class wrap {
        +Token
        +tokenize_markdown
    }
    class tokenize {
        +Token
        +tokenize_markdown
    }
    wrap ..> tokenize : re-exports
Loading

File-Level Changes

Change Details Files
Use shared setup-rust action in release workflow
  • Removed actions-rs/toolchain@v1.0.7 step
  • Added leynos/shared-actions/setup-rust step
.github/workflows/release.yml
Re-export tokenize_markdown in wrap module
  • Added pub use tokenize::tokenize_markdown
src/wrap.rs

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Aug 1, 2025

Summary by CodeRabbit

  • New Features

    • Made the tokenize_markdown functionality available for external use.
  • Chores

    • Updated the workflow to use a new Rust setup action for releases.

Walkthrough

Replace the Rust toolchain setup step in the GitHub release workflow with a custom shared action. Add a public re-export of the tokenize_markdown function in src/wrap.rs to expose it for external use. No other changes to workflow logic or code structure are introduced.

Changes

Cohort / File(s) Change Summary
GitHub Actions: Rust Toolchain Setup
.github/workflows/release.yml
Replace actions-rs/toolchain@v1.0.7 with custom leynos/shared-actions/.github/actions/setup-rust action for Rust setup.
Public API Exposure
src/wrap.rs
Add public re-export: pub use tokenize::tokenize_markdown; enabling external access to this function.

Sequence Diagram(s)

sequenceDiagram
    participant Workflow as GitHub Workflow
    participant SetupRust as setup-rust Action
    participant RustEnv as Rust Toolchain

    Workflow->>SetupRust: Run setup-rust action
    SetupRust->>RustEnv: Install/configure Rust toolchain
    RustEnv-->>SetupRust: Rust toolchain ready
    SetupRust-->>Workflow: Step complete
Loading
sequenceDiagram
    participant External as External Caller
    participant Wrap as src/wrap.rs
    participant Tokenize as tokenize module

    External->>Wrap: Call tokenize_markdown
    Wrap->>Tokenize: Forward call to tokenize_markdown
    Tokenize-->>Wrap: Return result
    Wrap-->>External: Return result
Loading

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

Rust arrives, now custom and neat,
With workflows trimmed—no toolchain repeat!
Markdown tokens march in line,
Publicly exported, feeling fine.
CI sings a lighter tune,
All set for a release soon! 🚀

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch codex/update-release.yml-to-use-setup-rust-action

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey @leynos - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@leynos
Copy link
Copy Markdown
Owner Author

leynos commented Aug 1, 2025

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Aug 1, 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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3b33368 and 4bc36d3.

📒 Files selected for processing (2)
  • .github/workflows/release.yml (1 hunks)
  • src/wrap.rs (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.rs

⚙️ CodeRabbit Configuration File

**/*.rs: * Seek to keep the cyclomatic complexity of functions no more than 12.

  • Adhere to single responsibility and CQRS

  • Place function attributes after doc comments.

  • Do not use return in single-line functions.

  • Move conditionals with >2 branches into a predicate function.

  • Avoid unsafe unless absolutely necessary.

  • Every module must begin with a //! doc comment that explains the module's purpose and utility.

  • Comments and docs must follow en-GB-oxendict (-ize / -our) spelling and grammar

  • Lints must not be silenced except as a last resort.

    • #[allow] is forbidden.
    • Only narrowly scoped #[expect(lint, reason = "...")] is allowed.
    • No lint groups, no blanket or file-wide suppression.
    • Include FIXME: with link if a fix is expected.
  • Use rstest fixtures for shared setup and to avoid repetition between tests.

  • Replace duplicated tests with #[rstest(...)] parameterised cases.

  • Prefer mockall for mocks/stubs.

  • Prefer .expect() over .unwrap()

  • Ensure that any API or behavioural changes are reflected in the documentation in docs/

  • Ensure that any completed roadmap steps are recorded in the appropriate roadmap in docs/

  • Files must not exceed 400 lines in length

    • Large modules must be decomposed
    • Long match statements or dispatch tables should be decomposed by domain and collocated with targets
    • Large blocks of inline data (e.g., test fixtures, constants or templates) must be moved to external files and inlined at compile-time or loaded at run-time.

Files:

  • src/wrap.rs
🧬 Code Graph Analysis (1)
src/wrap.rs (1)
src/wrap/tokenize.rs (1)
  • tokenize_markdown (150-184)

Comment thread .github/workflows/release.yml
Comment thread src/wrap.rs
@leynos leynos merged commit c27f876 into main Aug 1, 2025
2 checks passed
@leynos leynos deleted the codex/update-release.yml-to-use-setup-rust-action branch August 1, 2025 17:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant