Skip to content

refactor(taskfiles): Fix guideline violations and reorganize non-main taskfiles into a single directory.#829

Merged
kirkrodrigues merged 7 commits into
y-scope:mainfrom
kirkrodrigues:taskfile-refactoring
Apr 17, 2025
Merged

refactor(taskfiles): Fix guideline violations and reorganize non-main taskfiles into a single directory.#829
kirkrodrigues merged 7 commits into
y-scope:mainfrom
kirkrodrigues:taskfile-refactoring

Conversation

@kirkrodrigues

@kirkrodrigues kirkrodrigues commented Apr 16, 2025 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

Description

This PR:

  • to follow our Taskfile guidelines...
    • renames existing taskfiles to use the .yaml extension.
    • fixes the task attribute order in the docs taskfile.
  • to organize all the taskfiles into a single directory...
    • moves lint-tasks.yml to taskfiles/lint.yaml
    • moves deps-tasks.yml to taskfiles/deps.yaml
    • moves docs/tasks.yml to taskfiles/docs.yaml

To make the PR easier to review, the commits have also been split up into small operations.

Checklist

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

  • GitHub workflows succeeded.
  • task succeeded in building the package.

Summary by CodeRabbit

  • Chores
    • Updated workflow and task configuration file paths and names for consistency and standardization.
    • Adjusted references in automation and linting tasks to use new file locations and extensions.
  • Refactor
    • Standardized declaration of input sources and generated outputs in documentation-related tasks for improved clarity.

@kirkrodrigues kirkrodrigues requested a review from a team as a code owner April 16, 2025 18:09
@kirkrodrigues kirkrodrigues requested a review from Copilot April 16, 2025 18:10
@coderabbitai

coderabbitai Bot commented Apr 16, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Walkthrough

The changes update references to task configuration files across workflow and task management files. File names and paths for taskfiles are standardized, replacing .yml extensions and root-level locations with .yaml extensions and a taskfiles/ directory. Workflow trigger paths and taskfile includes are updated accordingly. In addition, explicit sources and generates fields are added to several documentation-related tasks to clarify dependencies and outputs. No logic, control flow, or exported/public entity declarations are otherwise modified.

Changes

Files/Paths Change Summary
.github/workflows/clp-core-build.yaml, .github/workflows/clp-core-build-macos.yaml Updated workflow trigger paths and filters to reference taskfile.yaml and taskfiles/deps.yaml instead of old file names.
taskfile.yaml Updated includes section to reference .yaml files within taskfiles/ directory; unchanged for utils.
taskfiles/deps.yaml, taskfiles/lint.yaml Updated references from Taskfile.yml to taskfile.yaml and from old .yml files to corresponding .yaml files in taskfiles/.
taskfiles/docs.yaml Added explicit sources and generates fields to tasks; standardized dependency and output declarations; updated dir for docs task.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant GitHub Actions
    participant Taskfile System

    Developer->>GitHub Actions: Push or PR with changes to taskfile.yaml/taskfiles/*.yaml
    GitHub Actions->>GitHub Actions: Detect changes via updated workflow trigger paths
    GitHub Actions->>Taskfile System: Run tasks referencing updated .yaml files in taskfiles/
    Taskfile System->>Taskfile System: Use explicit sources/generates for documentation tasks
Loading

Possibly related PRs

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ffbd533 and f6dbf94.

📒 Files selected for processing (6)
  • .github/workflows/clp-core-build-macos.yaml (2 hunks)
  • .github/workflows/clp-core-build.yaml (3 hunks)
  • taskfile.yaml (1 hunks)
  • taskfiles/deps.yaml (13 hunks)
  • taskfiles/docs.yaml (3 hunks)
  • taskfiles/lint.yaml (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: ubuntu-jammy-deps-image
  • GitHub Check: centos-stream-9-deps-image
  • GitHub Check: build-macos (macos-15, false)
  • GitHub Check: build-macos (macos-15, true)
  • GitHub Check: build-macos (macos-13, true)
  • GitHub Check: build-macos (macos-13, false)
  • GitHub Check: build-macos (macos-14, true)
🔇 Additional comments (6)
taskfile.yaml (1)

4-6: Taskfile includes updated for consistency and maintainability

The updated includes referencing taskfiles/deps.yaml, taskfiles/docs.yaml, and taskfiles/lint.yaml are correct and align with the new organization. This improves clarity and maintainability.

taskfiles/deps.yaml (1)

115-115: Updated taskfile references for consistency

All references to the main taskfile have been updated to taskfile.yaml, which matches the new naming convention and prevents broken links. This is a necessary and correct change.

Also applies to: 146-146, 176-176, 206-206, 236-236, 266-266, 296-296, 326-326, 358-358, 388-388, 418-418, 448-448, 478-478

taskfiles/lint.yaml (1)

77-77: Lint taskfile references updated for clarity and consistency

All references to taskfiles and the main taskfile have been updated to the new .yaml naming and directory structure. This ensures clarity and prevents errors due to outdated paths.

Also applies to: 120-122, 799-799, 828-828

.github/workflows/clp-core-build.yaml (1)

11-12: Workflow trigger paths updated for new taskfile structure

The workflow now correctly monitors taskfile.yaml and taskfiles/deps.yaml, ensuring CI triggers on relevant changes. This is a necessary update for the new organization.

Also applies to: 22-23, 90-91

.github/workflows/clp-core-build-macos.yaml (1)

15-16: macOS workflow trigger paths updated for new taskfile structure

The workflow now correctly monitors taskfile.yaml and taskfiles/deps.yaml, ensuring CI triggers on relevant changes. This is a necessary update for the new organization.

Also applies to: 29-30

taskfiles/docs.yaml (1)

25-32: Great improvement: Explicitly declaring sources, dir, and generates fields enhances reproducibility and maintainability.

These additions make task dependencies and outputs much clearer, supporting better caching and more predictable builds. This aligns well with Taskfile best practices.

Also applies to: 68-72, 96-99

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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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

Copilot AI reviewed Apr 16, 2025
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull Request Overview

This PR refactors taskfiles to adhere to new guidelines by renaming files to use the .yaml extension and consolidating non‐main taskfiles into a dedicated directory.

  • Renames file references from "Taskfile.yml" to "taskfile.yaml".
  • Moves lint-tasks.yml, deps-tasks.yml, and docs/tasks.yml into the taskfiles/ directory.
  • Updates workflow file references accordingly.

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

Show a summary per file
File Description
taskfiles/lint.yaml Updates file references to the new taskfile.yaml naming convention.
taskfiles/docs.yaml Adjusts source and directory locations following refactoring.
taskfiles/deps.yaml Replaces old Taskfile.yml references with taskfile.yaml.
taskfile.yaml Updates includes to point to the reorganized taskfiles in the taskfiles/ directory.
.github/workflows/clp-core-build.yaml Updates file paths in workflow triggers to match the renamed files.
.github/workflows/clp-core-build-macos.yaml Updates file paths in workflow triggers to match the renamed files.

@kirkrodrigues kirkrodrigues merged commit a8f6f2c into y-scope:main Apr 17, 2025
@kirkrodrigues kirkrodrigues deleted the taskfile-refactoring branch April 17, 2025 18:13
anlowee pushed a commit to anlowee/clp that referenced this pull request Apr 25, 2025
@kirkrodrigues
refactor(taskfiles): Fix guideline violations and reorganize non-main…
aaccd10 
… taskfiles into a single directory. (y-scope#829)
@coderabbitai coderabbitai Bot mentioned this pull request Apr 27, 2025
Merged
3 tasks
junhaoliao pushed a commit to junhaoliao/clp that referenced this pull request May 17, 2026
@kirkrodrigues
refactor(taskfiles): Fix guideline violations and reorganize non-main…
4221867 
… taskfiles into a single directory. (y-scope#829)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@Bill-hbrhbr Bill-hbrhbr Awaiting requested review from Bill-hbrhbr

+1 more reviewer

@haiqi96 haiqi96 haiqi96 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@kirkrodrigues @haiqi96