|
| 1 | +# ♻️ Daily Efficiency Improver |
| 2 | + |
| 3 | +> For an overview of all available workflows, see the [main README](../README.md). |
| 4 | +
|
| 5 | +The [Daily Efficiency Improver workflow](../workflows/daily-efficiency-improver.md?plain=1) is an energy-efficiency-focused repository assistant that runs daily to identify and implement improvements that reduce computational footprint. It discovers build/test/benchmark commands, identifies opportunities across code, data, network/I/O, and frontend behavior, implements measurable changes, maintains its own PRs, comments on relevant issues, invests in measurement infrastructure, and maintains a monthly activity summary for maintainer visibility. |
| 6 | + |
| 7 | +## Installation |
| 8 | + |
| 9 | +```bash |
| 10 | +# Install the 'gh aw' extension |
| 11 | +gh extension install github/gh-aw |
| 12 | + |
| 13 | +# Add the workflow to your repository |
| 14 | +gh aw add-wizard githubnext/agentics/daily-efficiency-improver |
| 15 | +``` |
| 16 | + |
| 17 | +This walks you through adding the workflow to your repository. |
| 18 | + |
| 19 | +## How It Works |
| 20 | + |
| 21 | +```mermaid |
| 22 | +graph LR |
| 23 | + A[Read Memory] --> B[Discover Commands] |
| 24 | + A --> C[Identify Opportunities] |
| 25 | + A --> D[Implement Improvements] |
| 26 | + A --> E[Maintain PRs] |
| 27 | + A --> F[Comment on Issues] |
| 28 | + A --> G[Invest in Infrastructure] |
| 29 | + A --> H[Update Activity Summary] |
| 30 | + B --> H |
| 31 | + C --> H |
| 32 | + D --> H |
| 33 | + E --> H |
| 34 | + F --> H |
| 35 | + G --> H |
| 36 | + H --> I[Save Memory] |
| 37 | +``` |
| 38 | + |
| 39 | +The workflow operates through seven coordinated tasks each run: |
| 40 | + |
| 41 | +### Task 1: Discover and Validate Build/Test/Benchmark Commands |
| 42 | + |
| 43 | +Analyzes the repository to discover build, test, benchmark, lint/format, and profiling commands. Cross-references against CI/config files, validates by running them, and stores successful commands in memory. |
| 44 | + |
| 45 | +### Task 2: Identify Energy Efficiency Opportunities |
| 46 | + |
| 47 | +Systematically scans for energy-related opportunities in four focus areas: code-level efficiency, data efficiency, network/I/O efficiency, and frontend/UI efficiency. Prioritizes opportunities by estimated impact and measurability. |
| 48 | + |
| 49 | +### Task 3: Implement Energy Efficiency Improvements |
| 50 | + |
| 51 | +Selects optimization goals from backlog, establishes baseline measurements, implements improvements, and measures outcomes. Creates draft PRs with before/after evidence, trade-offs, and reproducibility instructions. |
| 52 | + |
| 53 | +### Task 4: Maintain Efficiency Improver Pull Requests |
| 54 | + |
| 55 | +Keeps its own PRs healthy by fixing CI failures and resolving merge conflicts. Uses `push_to_pull_request_branch` to update PR branches directly. |
| 56 | + |
| 57 | +### Task 5: Comment on Efficiency-Related Issues |
| 58 | + |
| 59 | +Reviews open issues mentioning efficiency, performance, energy, or green software concerns. Suggests actionable investigation and measurement approaches. Maximum 3 comments per run. |
| 60 | + |
| 61 | +### Task 6: Invest in Energy Measurement Infrastructure |
| 62 | + |
| 63 | +Assesses benchmark and profiling coverage, identifies blind spots, and proposes or implements infrastructure improvements to better track and prevent efficiency regressions. |
| 64 | + |
| 65 | +### Task 7: Update Monthly Activity Summary |
| 66 | + |
| 67 | +Every run, updates a rolling monthly activity issue that gives maintainers one place to review efficiency work and suggested follow-up actions. |
| 68 | + |
| 69 | +### Guidelines Daily Efficiency Improver Follows |
| 70 | + |
| 71 | +- **Measure everything**: No efficiency claim without data |
| 72 | +- **No breaking changes**: Never changes public APIs without explicit approval |
| 73 | +- **No new dependencies**: Discusses in an issue first |
| 74 | +- **Small, focused PRs**: One optimization per PR for easier review and rollback |
| 75 | +- **Read AGENTS.md first**: Before starting work, reads project-specific conventions |
| 76 | +- **AI transparency**: Every output includes robot emoji disclosure |
| 77 | +- **Build, format, lint, and test verification**: Runs checks before creating PRs |
| 78 | +- **Exclude generated files**: Keep benchmark artifacts out of commits unless explicitly needed |
| 79 | + |
| 80 | +## Usage |
| 81 | + |
| 82 | +The main way to use Daily Efficiency Improver is to let it run daily and perform tasks autonomously. You can review activity via its monthly summary issue and related PRs/comments. |
| 83 | + |
| 84 | +### Configuration |
| 85 | + |
| 86 | +This workflow requires no configuration and works out of the box. It uses repo-memory to track work across runs and avoid duplicate actions. |
| 87 | + |
| 88 | +After editing run `gh aw compile` to update the workflow and commit all changes to the default branch. |
| 89 | + |
| 90 | +### Commands |
| 91 | + |
| 92 | +You can start a run immediately: |
| 93 | + |
| 94 | +```bash |
| 95 | +gh aw run daily-efficiency-improver |
| 96 | +``` |
| 97 | + |
| 98 | +To run repeatedly: |
| 99 | + |
| 100 | +```bash |
| 101 | +gh aw run daily-efficiency-improver --repeat 30 |
| 102 | +``` |
| 103 | + |
| 104 | +### Triggering CI on Pull Requests |
| 105 | + |
| 106 | +To automatically trigger CI checks on PRs created by this workflow, configure an additional repository secret `GH_AW_CI_TRIGGER_TOKEN`. See the [triggering CI documentation](https://github.github.com/gh-aw/reference/triggering-ci/) for setup instructions. |
| 107 | + |
| 108 | +### Human in the Loop |
| 109 | + |
| 110 | +- Review efficiency improvement PRs and measurement summaries |
| 111 | +- Validate claims through independent checks where needed |
| 112 | +- Assess code quality and maintainability of optimizations |
| 113 | +- Provide feedback through issue and PR comments |
0 commit comments