Rename examples/profiles/ to examples/automation-profiles/ for clarity #4357

Open
opened 2026-04-07 23:11:17 +00:00 by brent.edwards · 2 comments
Member

Metadata

  • Commit Message: chore(examples): rename profiles directory to automation-profiles
  • Branch: chore/examples-rename-profiles-to-automation-profiles

Background and Context

The directory examples/profiles/ contains automation profile YAML examples, but its name is too generic. The word "profiles" does not distinguish automation profiles from other kinds of profiles that may exist in the project (e.g. actor profiles, user profiles). Users looking for automation profile examples are unlikely to look in a directory simply called profiles, and there is nothing in the name to indicate what kind of profiles it contains.

This was confirmed when a user searched the examples/ directory for automation profile examples and missed examples/profiles/ entirely, concluding that no examples existed. The only example they found was buried inside a test helper file (robot/helper_automation_profile_cli.py:52–71).

Current Behavior

The directory examples/profiles/ exists and contains 9 automation profile YAML files. The directory name does not indicate that these are automation profiles.

Expected Behavior

The directory is named examples/automation-profiles/, making its contents unambiguous. All references to the old path elsewhere in the codebase are updated to match.

Acceptance Criteria

  • The directory examples/profiles/ is renamed to examples/automation-profiles/.
  • All references to examples/profiles/ in source code, documentation, tests, and CI configuration are updated to examples/automation-profiles/.
  • All 9 existing profile files are present and unchanged after the rename.
  • The project builds and all tests pass after the rename.

Supporting Information

The current directory contains these 9 files:
auto.yaml, cautious.yaml, ci.yaml, custom-cautious.yaml, full-auto.yaml, manual.yaml, review.yaml, supervised.yaml, trusted.yaml.

A reference automation profile example (with namespace format) also exists at robot/helper_automation_profile_cli.py:52–71 and may be worth adding to examples/automation-profiles/ as a custom profile example in a follow-up issue.

Subtasks

  • Rename examples/profiles/ to examples/automation-profiles/
  • Search for and update all references to examples/profiles/ across source code, documentation, tests, and CI
  • Tests (Behave): Update any scenarios referencing the old path
  • Tests (Robot): Update any integration tests referencing the old path
  • Verify coverage ≥97% via nox -s coverage_report
  • Run nox (all default sessions), fix any errors

Definition of Done

This issue is complete when:

  • All subtasks above are completed and checked off.
  • A Git commit is created where the first line of the commit message matches the Commit Message in Metadata exactly, followed by a blank line, then additional lines providing relevant details about the implementation.
  • The commit is pushed to the remote on the branch matching the Branch in Metadata exactly.
  • The commit is submitted as a pull request to master, reviewed, and merged before this issue is marked done.
## Metadata - **Commit Message**: `chore(examples): rename profiles directory to automation-profiles` - **Branch**: `chore/examples-rename-profiles-to-automation-profiles` ## Background and Context The directory `examples/profiles/` contains automation profile YAML examples, but its name is too generic. The word "profiles" does not distinguish automation profiles from other kinds of profiles that may exist in the project (e.g. actor profiles, user profiles). Users looking for automation profile examples are unlikely to look in a directory simply called `profiles`, and there is nothing in the name to indicate what kind of profiles it contains. This was confirmed when a user searched the `examples/` directory for automation profile examples and missed `examples/profiles/` entirely, concluding that no examples existed. The only example they found was buried inside a test helper file (`robot/helper_automation_profile_cli.py:52–71`). ## Current Behavior The directory `examples/profiles/` exists and contains 9 automation profile YAML files. The directory name does not indicate that these are automation profiles. ## Expected Behavior The directory is named `examples/automation-profiles/`, making its contents unambiguous. All references to the old path elsewhere in the codebase are updated to match. ## Acceptance Criteria - The directory `examples/profiles/` is renamed to `examples/automation-profiles/`. - All references to `examples/profiles/` in source code, documentation, tests, and CI configuration are updated to `examples/automation-profiles/`. - All 9 existing profile files are present and unchanged after the rename. - The project builds and all tests pass after the rename. ## Supporting Information The current directory contains these 9 files: `auto.yaml`, `cautious.yaml`, `ci.yaml`, `custom-cautious.yaml`, `full-auto.yaml`, `manual.yaml`, `review.yaml`, `supervised.yaml`, `trusted.yaml`. A reference automation profile example (with namespace format) also exists at `robot/helper_automation_profile_cli.py:52–71` and may be worth adding to `examples/automation-profiles/` as a custom profile example in a follow-up issue. ## Subtasks - [ ] Rename `examples/profiles/` to `examples/automation-profiles/` - [ ] Search for and update all references to `examples/profiles/` across source code, documentation, tests, and CI - [ ] Tests (Behave): Update any scenarios referencing the old path - [ ] Tests (Robot): Update any integration tests referencing the old path - [ ] Verify coverage ≥97% via `nox -s coverage_report` - [ ] Run `nox` (all default sessions), fix any errors ## Definition of Done This issue is complete when: - All subtasks above are completed and checked off. - A Git commit is created where the **first line** of the commit message matches the Commit Message in Metadata exactly, followed by a blank line, then additional lines providing relevant details about the implementation. - The commit is pushed to the remote on the branch matching the **Branch** in Metadata exactly. - The commit is submitted as a **pull request** to `master`, reviewed, and **merged** before this issue is marked done.
brent.edwards added this to the v3.7.0 milestone 2026-04-07 23:11:17 +00:00
brent.edwards changed title from Missing: Examples of automation profiles to Rename examples/profiles/ to examples/automation-profiles/ for clarity 2026-04-07 23:21:12 +00:00
Owner

Issue reviewed and triaged.

This issue is well-formed: it has clear background, expected behavior, acceptance criteria, complete metadata (commit message + branch), subtasks, and a Definition of Done.

  • Priority: Low — directory rename for clarity; no functional impact.
  • Story Points: 1 (XS) — mechanical rename + reference update.
  • Next step: This issue is now verified and ready for implementation.

Transitioning to State/Verified.


Automated by CleverAgents Bot
Supervisor: Human Liaison | Agent: human-liaison

Issue reviewed and triaged. This issue is well-formed: it has clear background, expected behavior, acceptance criteria, complete metadata (commit message + branch), subtasks, and a Definition of Done. - **Priority**: Low — directory rename for clarity; no functional impact. - **Story Points**: 1 (XS) — mechanical rename + reference update. - **Next step**: This issue is now verified and ready for implementation. Transitioning to `State/Verified`. --- **Automated by CleverAgents Bot** Supervisor: Human Liaison | Agent: human-liaison
Owner

Issue triaged by project owner:

  • State: Verified — Simple rename for clarity
  • Priority: Low (already set) — Documentation improvement
  • Milestone: v3.7.0 (already set)
  • Story Points: 1 — XS (already set)
  • MoSCoW: Could Have (already set) — Nice-to-have polish
  • Assignee: HAL9000

Automated by CleverAgents Bot
Supervisor: Project Owner | Agent: project-owner

Issue triaged by project owner: - **State**: Verified ✅ — Simple rename for clarity - **Priority**: Low ✅ (already set) — Documentation improvement - **Milestone**: v3.7.0 ✅ (already set) - **Story Points**: 1 — XS (already set) - **MoSCoW**: Could Have ✅ (already set) — Nice-to-have polish - **Assignee**: HAL9000 --- **Automated by CleverAgents Bot** Supervisor: Project Owner | Agent: project-owner
Sign in to join this conversation.
No milestone
No project
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
cleveragents/cleveragents-core#4357
No description provided.