Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

chore: move example workflows #304

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
2bndy5 merged 1 commit into main from mv-example-workflows
Aug 12, 2025
Merged

chore: move example workflows #304

2bndy5 merged 1 commit into main from mv-example-workflows
Aug 12, 2025

Conversation

@2bndy5
Copy link
Collaborator

@2bndy5 2bndy5 commented Aug 12, 2025 •
edited by coderabbitai bot
Loading

follow up to #303

Summary by CodeRabbit

  • Documentation

    • Updated example GitHub Actions references to point to the new workflows location, ensuring all example links and snippets use the correct paths.

  • Chores

    • Refined Dependabot configuration to monitor the repository root only, reducing unnecessary checks and streamlining dependency update notifications.

@2bndy5 2bndy5 requested a review from a team as a code owner August 12, 2025 09:55
@2bndy5 2bndy5 requested review from shenxianpeng and removed request for a team August 12, 2025 09:55
@2bndy5 2bndy5 added documentation Improvements or additions to documentation dependencies Pull requests that update a dependency file github_actions Pull requests that update GitHub Actions code labels Aug 12, 2025
Copy link
Contributor

coderabbitai bot commented Aug 12, 2025

Walkthrough

Dependabot configuration was narrowed to scan only the repository root for GitHub Actions updates. Documentation examples were updated to reference workflow YAML files moved under .github/workflows/examples instead of docs/examples.

Changes

Cohort / File(s) Summary
Dependabot configuration
.github/dependabot.yml		 Replaced actions update path from a directories list ("/", "docs/examples") to a single directory: "/". Other settings unchanged.
Docs examples references
docs/examples/index.md		 Updated three code block paths to point to .github/workflows/examples/*.yml instead of docs/examples/*.yml.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch mv-example-workflows

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
🪧 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.
    • 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.
  • 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 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/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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
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: 1

🔭 Outside diff range comments (2)
.github/dependabot.yml (2)

9-15: If recursion is not guaranteed, add a second updater for the examples path

If Dependabot doesn’t recurse into subfolders, add a dedicated github-actions updater to keep example workflow references current.

Apply this diff:

 updates:
 - package-ecosystem: github-actions
 directory: "/"
 schedule:
 interval: "weekly"
 groups:
 actions:
 patterns:
 - "*"
+ - package-ecosystem: github-actions
+ directory: "/.github/workflows/examples"
+ schedule:
+ interval: "weekly"
+ groups:
+ actions:
+ patterns:
+ - "*"
 - package-ecosystem: pip
 directory: /
 schedule:
 interval: "daily"
 groups:
 pip:
 patterns:
 - "*"

9-15: Add Dependabot entry for example workflows

Dependabot’s GitHub Actions scanner doesn’t recurse into subfolders of .github/workflows; workflows under .github/workflows/examples won’t be picked up by your existing
directory: "/" entry. To ensure those example workflows get their action pins updated:

• In .github/dependabot.yml (around lines 9–15), add a second update block:

- package-ecosystem: "github-actions"
 directory: "/.github/workflows/examples"
 schedule:
 interval: "weekly"

• Or, if your org has the Dependabot multi-directory beta enabled, consolidate both paths:

- package-ecosystem: "github-actions"
 directories:
 - "/"
 - "/.github/workflows/examples"
 schedule:
 interval: "weekly"

This change will ensure Dependabot scans and updates your nested example workflows.

🧹 Nitpick comments (1)
.github/dependabot.yml (1)

16-23: Optional: Keep YAML quoting consistent

Minor consistency nit: directory is quoted for github-actions but unquoted for pip. YAML doesn’t require quotes here, but aligning styles improves readability.

- - package-ecosystem: pip
- directory: /
+ - package-ecosystem: pip
+ directory: "/"
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bac2e30 and e8fcc1f.

📒 Files selected for processing (2)
  • .github/dependabot.yml (1 hunks)
  • docs/examples/index.md (3 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings 
Learnt from: 2bndy5
PR: cpp-linter/cpp-linter-action#303
File: .github/dependabot.yml:0-0
Timestamp: 2025年08月12日T08:57:29.223Z
Learning: For Dependabot's github-actions ecosystem, multiple directories in the directories list are supported. When directory is "/", Dependabot scans both .github/workflows/ and root action.yml/action.yaml files. Other directory entries are treated as workflow directories and scanned for .yml/.yaml files.
📚 Learning: 2025年08月12日T08:57:29.223Z 
Learnt from: 2bndy5
PR: cpp-linter/cpp-linter-action#303
File: .github/dependabot.yml:0-0
Timestamp: 2025年08月12日T08:57:29.223Z
Learning: For Dependabot's github-actions ecosystem, multiple directories in the directories list are supported. When directory is "/", Dependabot scans both .github/workflows/ and root action.yml/action.yaml files. Other directory entries are treated as workflow directories and scanned for .yml/.yaml files.

Applied to files:

  • .github/dependabot.yml
🔇 Additional comments (1)
docs/examples/index.md (1)

13-14: Docs updates align with the file relocation

The includes reflect the new examples location and keep the docs DRY by embedding the actual workflow files. Assuming path resolution is correct, this looks good.

Also applies to: 22-23, 31-32

@2bndy5 2bndy5 merged commit 483a97b into main Aug 12, 2025
6 checks passed
@2bndy5 2bndy5 deleted the mv-example-workflows branch August 12, 2025 10:35
@shenxianpeng shenxianpeng removed the documentation Improvements or additions to documentation label Aug 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@shenxianpeng shenxianpeng shenxianpeng approved these changes

Assignees

No one assigned

Labels

dependencies Pull requests that update a dependency file github_actions Pull requests that update GitHub Actions code

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /