Task Runner Automation¶

This document explains how the Task runner is used to automate common operations in the ArgoCD demonstration project.

Overview¶

The project uses Task (a task runner / build tool) to automate common operations and provide a consistent interface for working with the project. Task is a modern alternative to Make, with a focus on simplicity and ease of use.

Taskfile Structure¶

The main task definitions are stored in Taskfile.yml at the root of the project. Additional task files, such as Taskfile.gitflow.yml, provide repeatable gitflow functionality (optional).

Available tasks:

Task Execution¶

Tasks are executed using the task command:

# Run the default task
task

# Run a specific task
task create-cluster

# Run a task with arguments
task feature-start my-new-feature

Extending Task Automation¶

To add new tasks:

1. Edit the appropriate Taskfile (e.g., Taskfile.yml)
2. Define the new task with a description and commands
3. Add any dependencies or variables needed
4. Save the file and run task --list-all to verify

Example of adding a new task:

deploy-app:
  desc: "Deploy a sample application"
  deps:
    - install-argocd
  cmds:
    - kubectl apply -f 0-application.yaml
    - kubectl apply -f 1-application.yaml

Best Practices¶

1. Descriptive Names: Use clear, descriptive names for tasks
2. Add Descriptions: Include a description for each task
3. Use Dependencies: Define task dependencies explicitly
4. Idempotent Commands: Make tasks safe to run multiple times
5. Status Checks: Use status checks to avoid unnecessary work
6. Organize Tasks: Group related tasks in separate Taskfiles
7. Document Tasks: Include task documentation in project docs

Related Documentation¶

• ArgoCD Overview
• Architecture Overview