Skip to content

Expand Netsukefile workflow scenarios#54

Merged
leynos merged 2 commits intomainfrom
codex/extend-netsukefile-test.yml-with-scenarios
Aug 5, 2025
Merged

Expand Netsukefile workflow scenarios#54
leynos merged 2 commits intomainfrom
codex/extend-netsukefile-test.yml-with-scenarios

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Aug 5, 2025

Summary

  • exercise dependent targets, inline commands, and scripts in the netsukefile test workflow
  • run netsuke actions from the command line and ensure unused actions are skipped

Testing

  • make fmt
  • make lint
  • make test

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

Summary by Sourcery

Extend the netsukefile-test GitHub Actions workflow to cover dependent targets, inline commands, inline scripts, and CLI-run actions, and to assert artifact creation and skipping of unused actions.

CI:

  • Expand CI workflow to exercise dependent targets, inline commands, inline scripts, and netsuke actions via CLI
  • Add CI assertions for multiple artifacts and verify unused actions are skipped

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Aug 5, 2025

Reviewer's Guide

This PR enriches the GitHub Actions netsukefile-test workflow by replacing the single generated.txt target with multiple dependent and inline targets, adding action definitions (including an unused action), and updating build and assertion steps to validate both file outputs and action behavior.

File-Level Changes

Change Details Files
Expanded Netsukefile test manifest with multiple targets and actions
  • Replaced single 'generated.txt' entry with base, dependent, inline-command, and inline-script targets
  • Added a script-based target for inline-script.txt
  • Defined two actions: 'say-hello' (used) and 'unused-action' (skipped)
.github/workflows/netsukefile-test.yml
Adjusted build steps to handle multiple targets and actions
  • Modified build command to include dependent.txt, inline-command.txt, and inline-script.txt
  • Added a separate step to run the 'say-hello' action target
.github/workflows/netsukefile-test.yml
Enhanced assertion steps for file and action outputs
  • Added assertions for base.txt and dependent.txt existence
  • Added separate checks for inline-command.txt and inline-script.txt
  • Checked that action-called.txt exists and unused.txt does not
.github/workflows/netsukefile-test.yml

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 5, 2025

Warning

Rate limit exceeded

@leynos has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 16 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between a319c87 and ba16f36.

📒 Files selected for processing (1)
  • .github/workflows/netsukefile-test.yml (1 hunks)

Summary by CodeRabbit

  • Chores
    • Expanded workflow to test multiple build targets and actions.
    • Added checks for the existence of generated files from various targets and actions.
    • Improved assertions to verify correct build outputs and unused actions.
    • Minor update to heredoc delimiter for workflow configuration.

Walkthrough

Expand the GitHub Actions workflow for Netsukefile testing by defining multiple build targets, adding new actions, and updating build and assertion steps to handle these targets. Modify the heredoc delimiter in the workflow configuration. No changes were made to exported or public entities.

Changes

Cohort / File(s) Change Summary
Workflow Enhancement
.github/workflows/netsukefile-test.yml
Define multiple Netsukefile targets (base.txt, dependent.txt, inline-command.txt, inline-script.txt). Add say-hello and unused-action actions. Update build steps to handle multiple targets and assert their existence. Change heredoc delimiter for Netsukefile content.

Sequence Diagram(s)

sequenceDiagram
    participant Workflow
    participant Netsukefile
    participant FileSystem

    Workflow->>Netsukefile: Define targets (base.txt, dependent.txt, inline-command.txt, inline-script.txt)
    Workflow->>Netsukefile: Add actions (say-hello, unused-action)
    Workflow->>Netsukefile: Build multiple targets
    Netsukefile->>FileSystem: Create/modify files per target definitions
    Workflow->>FileSystem: Assert existence of generated files
    Workflow->>Netsukefile: Build say-hello action target
    Workflow->>FileSystem: Assert say-hello artifact exists
    Workflow->>FileSystem: Assert unused-action artifact does not exist
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Suggested reviewers

  • codescene-delta-analysis

Poem

In the workflow’s dance, new targets appear,
Files touched and copied, intentions clear.
Actions say hello, some left unused,
Assertions abound, logic infused.
Netsukefile grows, its script refined—
A symphony of steps, perfectly aligned!
📝✨

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch codex/extend-netsukefile-test.yml-with-scenarios

🪧 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.
  • 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.

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 33e5278 and a319c87.

📒 Files selected for processing (1)
  • .github/workflows/netsukefile-test.yml (1 hunks)

Comment thread .github/workflows/netsukefile-test.yml Outdated
Comment on lines +53 to +68
- name: Build dependent and inline targets
run: ./target/debug/netsuke --verbose build dependent.txt inline-command.txt inline-script.txt
- name: Assert dependent artefacts exist
run: |
scripts/assert-file-exists.sh base.txt
scripts/assert-file-exists.sh dependent.txt
- name: Assert inline command artefact exists
run: scripts/assert-file-exists.sh inline-command.txt
- name: Assert inline script artefact exists
run: scripts/assert-file-exists.sh inline-script.txt
- name: Run action target
run: ./target/debug/netsuke --verbose build say-hello
- name: Assert action artefact exists
run: scripts/assert-file-exists.sh action-called.txt
- name: Assert unused action artefact absent
run: test ! -f unused.txt
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🧹 Nitpick (assertive)

Group all build targets in a single Netsuke invocation to cut CI time

You launch Netsuke twice: once for the three inline/dependency targets and once for say-hello.
Building everything in one call avoids the second binary start-up, re-parsing of the manifest and cache lookup, shaving a few seconds off each run.

-      - name: Build dependent and inline targets
-        run: ./target/debug/netsuke --verbose build dependent.txt inline-command.txt inline-script.txt
+      - name: Build all required targets
+        run: ./target/debug/netsuke --verbose build \
+          dependent.txt inline-command.txt inline-script.txt say-hello
...
-      - name: Run action target
-        run: ./target/debug/netsuke --verbose build say-hello
+      # call above already builds say-hello
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- name: Build dependent and inline targets
run: ./target/debug/netsuke --verbose build dependent.txt inline-command.txt inline-script.txt
- name: Assert dependent artefacts exist
run: |
scripts/assert-file-exists.sh base.txt
scripts/assert-file-exists.sh dependent.txt
- name: Assert inline command artefact exists
run: scripts/assert-file-exists.sh inline-command.txt
- name: Assert inline script artefact exists
run: scripts/assert-file-exists.sh inline-script.txt
- name: Run action target
run: ./target/debug/netsuke --verbose build say-hello
- name: Assert action artefact exists
run: scripts/assert-file-exists.sh action-called.txt
- name: Assert unused action artefact absent
run: test ! -f unused.txt
- name: Build all required targets
run: ./target/debug/netsuke --verbose build \
dependent.txt inline-command.txt inline-script.txt say-hello
- name: Assert dependent artefacts exist
run: |
scripts/assert-file-exists.sh base.txt
scripts/assert-file-exists.sh dependent.txt
- name: Assert inline command artefact exists
run: scripts/assert-file-exists.sh inline-command.txt
- name: Assert inline script artefact exists
run: scripts/assert-file-exists.sh inline-script.txt
# call above already builds say-hello
- name: Assert action artefact exists
run: scripts/assert-file-exists.sh action-called.txt
- name: Assert unused action artefact absent
run: test ! -f unused.txt
🤖 Prompt for AI Agents
In .github/workflows/netsukefile-test.yml around lines 53 to 68, the workflow
runs the Netsuke build command twice separately for different targets, causing
unnecessary overhead. To fix this, combine all build targets (dependent.txt,
inline-command.txt, inline-script.txt, and say-hello) into a single Netsuke
invocation by listing them all in one command line. This reduces CI time by
avoiding multiple binary startups and repeated manifest parsing.

@leynos leynos force-pushed the codex/extend-netsukefile-test.yml-with-scenarios branch from 689c8df to ba16f36 Compare August 5, 2025 23:43
@leynos leynos merged commit 9aae022 into main Aug 5, 2025
3 of 4 checks passed
@leynos leynos deleted the codex/extend-netsukefile-test.yml-with-scenarios branch August 5, 2025 23:59
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