Skip to content

Add common Taskfile task metadata#498

Merged
KooshaPari merged 1 commit into
mainfrom
codex/taskfile-common-tasks
Apr 28, 2026
Merged

Add common Taskfile task metadata#498
KooshaPari merged 1 commit into
mainfrom
codex/taskfile-common-tasks

Conversation

@KooshaPari
Copy link
Copy Markdown
Owner

@KooshaPari KooshaPari commented Apr 28, 2026

User description

Co-authored-by: Codex noreply@openai.com

Note

Low Risk
Low risk: changes are limited to Taskfile metadata and variable-based path/binary configuration, affecting only developer automation workflows.

Overview
Adds summary metadata to the top-level build, test, lint, and clean tasks to better document what each composite task runs.

Parameterizes common Taskfile values via new vars (FRONTEND_DIR, DOCS_DIR, GO_BINARY, GO_PACKAGES) and updates Go/Bun/docs build/test/vet/clean commands to use these variables instead of hard-coded paths (including cleaning the configured Go binary and frontend/docs artifacts).

Reviewed by Cursor Bugbot for commit a51a1f9. Bugbot is set up for automated code reviews on this repo. Configure here.


CodeAnt-AI Description

Document common tasks and make build paths configurable

What Changed

  • Added short summaries to the main build, test, lint, and clean tasks so task lists explain what each one does
  • Made the frontend, docs, Go binary name, and Go package paths configurable instead of tied to fixed folder names
  • Updated build, test, lint, and clean steps to use those shared values, including removing the configured Go binary and generated frontend/docs files during cleanup

Impact

✅ Clearer task descriptions
✅ Easier reuse across different project layouts
✅ More complete cleanup of generated build files

🔄 Retrigger CodeAnt AI Review

Details

💡 Usage Guide

Checking Your Pull Request

Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.

Talking to CodeAnt AI

Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:

@codeant-ai ask: Your question here

This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.

Example

@codeant-ai ask: Can you suggest a safer alternative to storing this secret?

Preserve Org Learnings with CodeAnt

You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:

@codeant-ai: Your feedback here

This helps CodeAnt AI learn and adapt to your team's coding style and standards.

Example

@codeant-ai: Do not flag unused imports.

Retrigger review

Ask CodeAnt AI to review the PR again, by typing:

@codeant-ai: review

Check Your Repository Health

To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.

Co-authored-by: Codex <noreply@openai.com>
@gemini-code-assist
Copy link
Copy Markdown

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

@codeant-ai
Copy link
Copy Markdown

codeant-ai Bot commented Apr 28, 2026

CodeAnt AI is reviewing your PR.


Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 28, 2026

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

The PR updates Taskfile.yml to introduce configurable variables for frontend, docs, and Go output directories, replaces hardcoded paths with variable references, enhances task descriptions with summary blocks, and removes status gating checks for frontend/docs package.json.

Changes

Cohort / File(s) Summary
Variable Configuration
Taskfile.yml
Added configurable vars for FRONTEND_DIR, DOCS_DIR, GO_BINARY, and GO_PACKAGES. Updated build:go, test:go, and vet tasks to use parameterized values instead of hardcoded paths and patterns.
Frontend & Docs Task Parameterization
Taskfile.yml
Parameterized working directories in build:chat, test:chat, lint:chat, and build:docs tasks to use new FRONTEND_DIR and DOCS_DIR variables.
Task Enhancements & Cleanup
Taskfile.yml
Added descriptive summary blocks to build, test, lint, and clean tasks. Updated clean:go, clean:chat, and clean:docs to use parameterized directory/binary vars and removed status gating checks for package.json files.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 Hops of joy, our tasks now sing,
With variables set for everything,
No more hardcoding, paths run free,
The Taskfile's config, light as can be! 🌟

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The PR description provides a clear overview with risk assessment, objectives, and technical details, but does not follow the repository's description template structure. Restructure the description to follow the template: add explicit Summary, Changes, Testing, Validation, and Merge Readiness sections with checkboxes as specified.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding common Taskfile task metadata (summary blocks) to composite tasks.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/taskfile-common-tasks

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

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

@sonarqubecloud
Copy link
Copy Markdown

@codeant-ai codeant-ai Bot added the size:S This PR changes 10-29 lines, ignoring generated files label Apr 28, 2026
@codeant-ai
Copy link
Copy Markdown

codeant-ai Bot commented Apr 28, 2026

CodeAnt AI finished reviewing your PR.

@KooshaPari KooshaPari merged commit 82597e4 into main Apr 28, 2026
17 of 30 checks passed
@KooshaPari KooshaPari deleted the codex/taskfile-common-tasks branch April 28, 2026 17:16
@codeant-ai
Copy link
Copy Markdown

codeant-ai Bot commented May 3, 2026

CodeAnt AI is running the review.


Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

@codeant-ai codeant-ai Bot added size:S This PR changes 10-29 lines, ignoring generated files and removed size:S This PR changes 10-29 lines, ignoring generated files labels May 3, 2026
@codeant-ai
Copy link
Copy Markdown

codeant-ai Bot commented May 3, 2026

Sequence Diagram

This PR updates Taskfile tasks so build, test, lint, and clean flows use shared configuration for Go packages, Go binary name, and frontend/docs directories, while adding summaries that document what each composite task runs.

sequenceDiagram
    participant Developer
    participant TaskRunner
    participant GoToolchain
    participant FrontendTooling
    participant DocsTooling

    Developer->>TaskRunner: Run build task
    TaskRunner->>GoToolchain: Build Go binary using configured name and packages
    TaskRunner->>FrontendTooling: Build frontend in configured frontend directory
    TaskRunner->>DocsTooling: Build docs in configured docs directory

    Developer->>TaskRunner: Run clean task
    TaskRunner->>GoToolchain: Clean Go cache and remove configured binary
    TaskRunner->>FrontendTooling: Remove frontend build artifacts in configured directory
    TaskRunner->>DocsTooling: Remove docs cache in configured directory
Loading

Generated by CodeAnt AI

@codeant-ai
Copy link
Copy Markdown

codeant-ai Bot commented May 3, 2026

CodeAnt AI finished running the review.


Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

@codeant-ai
Copy link
Copy Markdown

codeant-ai Bot commented May 5, 2026

CodeAnt AI is running the review.


Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

@codeant-ai codeant-ai Bot added size:S This PR changes 10-29 lines, ignoring generated files and removed size:S This PR changes 10-29 lines, ignoring generated files labels May 5, 2026
@codeant-ai
Copy link
Copy Markdown

codeant-ai Bot commented May 5, 2026

Sequence Diagram

This PR centralizes Taskfile configuration for Go, frontend, and docs paths and names, and updates the build and clean tasks to use these shared variables so they operate on the configured binary and artifact locations.

sequenceDiagram
    participant Developer
    participant Taskfile
    participant Go tools
    participant Frontend tools
    participant Docs tools

    Developer->>Taskfile: Run build task
    Taskfile->>Go tools: Build Go binary with configured name
    Taskfile->>Frontend tools: Build frontend in configured directory
    Taskfile->>Docs tools: Build docs in configured directory when vendor exists

    Developer->>Taskfile: Run clean task
    Taskfile->>Go tools: Clean cache and remove configured Go binary
    Taskfile->>Frontend tools: Remove frontend build artifacts in configured directory
    Taskfile->>Docs tools: Remove docs cache in configured directory
Loading

Generated by CodeAnt AI

@codeant-ai
Copy link
Copy Markdown

codeant-ai Bot commented May 5, 2026

CodeAnt AI finished running the review.


Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

@codeant-ai
Copy link
Copy Markdown

codeant-ai Bot commented May 7, 2026

CodeAnt AI is running the review.


Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

@codeant-ai codeant-ai Bot added size:S This PR changes 10-29 lines, ignoring generated files and removed size:S This PR changes 10-29 lines, ignoring generated files labels May 7, 2026
@codeant-ai
Copy link
Copy Markdown

codeant-ai Bot commented May 7, 2026

Sequence Diagram

This diagram shows how the main build task now orchestrates Go, frontend, and docs builds using configurable paths and binary/package settings, with added summaries for clearer task documentation.

sequenceDiagram
    participant Developer
    participant TaskRunner
    participant GoBuild
    participant FrontendBuild
    participant DocsBuild

    Developer->>TaskRunner: Run build task
    TaskRunner->>TaskRunner: Load configured vars and summaries
    TaskRunner->>GoBuild: Build Go binary with configured name and packages
    TaskRunner->>FrontendBuild: Build frontend in configured directory
    TaskRunner->>DocsBuild: Build docs in configured directory when vendor exists
    TaskRunner-->>Developer: Report build completion for all targets
Loading

Generated by CodeAnt AI

@codeant-ai
Copy link
Copy Markdown

codeant-ai Bot commented May 7, 2026

CodeAnt AI finished running the review.


Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

@codeant-ai
Copy link
Copy Markdown

codeant-ai Bot commented May 9, 2026

CodeAnt AI is running the review.


Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

@codeant-ai codeant-ai Bot added size:S This PR changes 10-29 lines, ignoring generated files and removed size:S This PR changes 10-29 lines, ignoring generated files labels May 9, 2026
@codeant-ai
Copy link
Copy Markdown

codeant-ai Bot commented May 9, 2026

Sequence Diagram

This diagram shows how the updated Taskfile orchestrates build, test, lint, and clean workflows using shared variables for Go, frontend, and docs paths, and exposes clearer summaries for the main tasks.

sequenceDiagram
    participant Developer
    participant Task
    participant Go
    participant Frontend
    participant Docs

    Developer->>Task: List tasks
    Task-->>Developer: Show build test lint clean with summaries

    Developer->>Task: Run composite task build or test or lint or clean
    Task->>Go: Use shared vars to run Go build test lint or clean
    Task->>Frontend: Use shared frontend dir to run build test lint or clean
    Task->>Docs: Use shared docs dir to conditionally build or clean docs
Loading

Generated by CodeAnt AI

@codeant-ai
Copy link
Copy Markdown

codeant-ai Bot commented May 9, 2026

CodeAnt AI finished running the review.


Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:S This PR changes 10-29 lines, ignoring generated files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant