antelope-cli 1.2.0 → 1.2.1

package/ansible/onboarding-ca/README.md

@@ -1,72 +1,72 @@
-# Client Area brand onboarding (Ansible)
-
-Automates onboarding a new client brand into
-[`web-client-area`](https://bitbucket.org/xsitesinc/web-client-area): it creates the brand
-assets and opens the pull request(s), reproducing the manual onboarding PRs
-(e.g. [#4266](https://bitbucket.org/xsitesinc/web-client-area/pull-requests/4266)).
-
-Per brand it creates, under the target repo:
-
-- `src/assets/other/<folder>/<folder>.scss` — empty stylesheet
-- `src/assets/other/<folder>/legal/risk-disclaimer.html` — the standard disclaimer
-
-The file creation is delegated to the `onboarding-ca` command of the published
-[`antelope-cli`](https://www.npmjs.com/package/antelope-cli) (`npx antelope-cli@<version> onboarding-ca`);
-this role owns cloning, branching, committing, pushing and PR creation.
-
-## Preconditions (control node)
-
-- `git`, Node.js (engines `^16.20.2`) and `npx` on `PATH`.
-- An **SSH key authorized to push** to `xsitesinc/web-client-area` (push is over SSH).
-- A **Bitbucket API token** with pull-request write access (used only for the REST calls:
-  reviewer lookup + PR creation). Store it in Ansible Vault or pass via environment — never commit it.
-- `ansible.builtin.uri` needs Python `urllib` (standard). No extra collections required.
-
-## Usage
-
-Interactive (prompts for the inputs):
-
-```bash
-ansible-playbook onboard-ca.yml
-```
-
-Non-interactive (for CI / wrapping playbooks) — extra-vars skip the prompts:
-
-```bash
-ansible-playbook onboard-ca.yml \
-  -e brand_name="Zenith Horizon Group" \
-  -e jira_key=ATLP-47067 \
-  -e dest_branches=develop,master-26.9 \
-  -e bitbucket_token="$BITBUCKET_TOKEN"
-```
-
-## Inputs
-
-| var | required | example | notes |
-|-----|----------|---------|-------|
-| `brand_name` | yes | `Zenith Horizon Group` | display name → PR title |
-| `jira_key` | yes | `ATLP-47067` | PR title prefix + branch name |
-| `dest_branches` | yes | `develop,master-26.9` | comma-separated; **one PR per branch** |
-| `bitbucket_token` | yes | *(secret)* | Bearer token for the REST calls |
-| `brand_assets_folder` | no | `zenithhorizongroup` | folder name → CLI `--brand_assets_folder`, branch name; prompted separately. Blank ⇒ derived from `brand_name` (lowercased, spaces removed) |
-| `reviewers` | no | *(auto)* | default: repo's Bitbucket default-reviewers (author excluded); override with `[{account_id: "..."}]` |
-| `antelope_cli_version` | no | `1.2.0` | pinned published CLI version |
-| `work_dir` | no | `/tmp/onboard-ca/web-client-area` | clone location |
-| `git_user_name` / `git_user_email` | no | | commit identity |
-
-## Behavior notes
-
-- **One PR per destination branch.** `develop` → `feature/<jira>-onboarding-<folder>`;
-  `master-*`/`release-*` → `hotfix/<jira>-onboarding-<folder>`. Each branch is based on its own
-  destination so diverged histories don't bleed across PRs.
-- **Reviewers** are read from the repo's Bitbucket *Default reviewers* config; the authenticating
-  account is excluded (Bitbucket rejects a PR whose author is a reviewer).
-- **Idempotent:** re-running with the same inputs recreates the (identical) files on the existing
-  source branch, detects no staged changes, skips commit/push, and tolerates the "PR already exists"
-  response (HTTP 400).
-- The playbook prints a summary of created PRs (destination, source branch, status, URL).
-
-## Scope
-
-Client Area only. web-crm onboarding is a separate, independent process (its file edits live in
-antelope-cli's existing `onboarding` command) and is not run by this playbook.
+# Client Area brand onboarding (Ansible)
+
+Automates onboarding a new client brand into
+[`web-client-area`](https://bitbucket.org/xsitesinc/web-client-area): it creates the brand
+assets and opens the pull request(s), reproducing the manual onboarding PRs
+(e.g. [#4266](https://bitbucket.org/xsitesinc/web-client-area/pull-requests/4266)).
+
+Per brand it creates, under the target repo:
+
+- `src/assets/other/<folder>/<folder>.scss` — empty stylesheet
+- `src/assets/other/<folder>/legal/risk-disclaimer.html` — the standard disclaimer
+
+The file creation is delegated to the `onboarding-ca` command of the published
+[`antelope-cli`](https://www.npmjs.com/package/antelope-cli) (`npx antelope-cli@<version> onboarding-ca`);
+this role owns cloning, branching, committing, pushing and PR creation.
+
+## Preconditions (control node)
+
+- `git`, Node.js (engines `^16.20.2`) and `npx` on `PATH`.
+- An **SSH key authorized to push** to `xsitesinc/web-client-area` (push is over SSH).
+- A **Bitbucket API token** with pull-request write access (used only for the REST calls:
+  reviewer lookup + PR creation). Store it in Ansible Vault or pass via environment — never commit it.
+- `ansible.builtin.uri` needs Python `urllib` (standard). No extra collections required.
+
+## Usage
+
+Interactive (prompts for the inputs):
+
+```bash
+ansible-playbook onboard-ca.yml
+```
+
+Non-interactive (for CI / wrapping playbooks) — extra-vars skip the prompts:
+
+```bash
+ansible-playbook onboard-ca.yml \
+  -e brand_name="Zenith Horizon Group" \
+  -e jira_key=ATLP-47067 \
+  -e dest_branches=develop,master-26.9 \
+  -e bitbucket_token="$BITBUCKET_TOKEN"
+```
+
+## Inputs
+
+| var | required | example | notes |
+|-----|----------|---------|-------|
+| `brand_name` | yes | `Zenith Horizon Group` | display name → PR title |
+| `jira_key` | yes | `ATLP-47067` | PR title prefix + branch name |
+| `dest_branches` | yes | `develop,master-26.9` | comma-separated; **one PR per branch** |
+| `bitbucket_token` | yes | *(secret)* | Bearer token for the REST calls |
+| `brand_assets_folder` | no | `zenithhorizongroup` | folder name → CLI `--brand_assets_folder`, branch name; prompted separately. Blank ⇒ derived from `brand_name` (lowercased, spaces removed) |
+| `reviewers` | no | *(auto)* | default: repo's Bitbucket default-reviewers (author excluded); override with `[{account_id: "..."}]` |
+| `antelope_cli_version` | no | `1.2.0` | pinned published CLI version |
+| `work_dir` | no | `/tmp/onboard-ca/web-client-area` | clone location |
+| `git_user_name` / `git_user_email` | no | | commit identity |
+
+## Behavior notes
+
+- **One PR per destination branch.** `develop` → `feature/<jira>-onboarding-<folder>`;
+  `master-*`/`release-*` → `hotfix/<jira>-onboarding-<folder>`. Each branch is based on its own
+  destination so diverged histories don't bleed across PRs.
+- **Reviewers** are read from the repo's Bitbucket *Default reviewers* config; the authenticating
+  account is excluded (Bitbucket rejects a PR whose author is a reviewer).
+- **Idempotent:** re-running with the same inputs recreates the (identical) files on the existing
+  source branch, detects no staged changes, skips commit/push, and tolerates the "PR already exists"
+  response (HTTP 400).
+- The playbook prints a summary of created PRs (destination, source branch, status, URL).
+
+## Scope
+
+Client Area only. web-crm onboarding is a separate, independent process (its file edits live in
+antelope-cli's existing `onboarding` command) and is not run by this playbook.

package/ansible/onboarding-ca/onboard-ca.yml

@@ -1,41 +1,41 @@
----
-# Onboard a Client Area brand into web-client-area and open the PR(s).
-#
-# Interactive:
-#   ansible-playbook onboard-ca.yml
-#
-# Non-interactive (e.g. from another playbook / CI), pass everything as extra-vars:
-#   ansible-playbook onboard-ca.yml \
-#     -e brand_name="Zenith Horizon Group" \
-#     -e brand_assets_folder=zenithhorizongroup \
-#     -e jira_key=ATLP-47067 \
-#     -e dest_branches=develop,master-26.9 \
-#     -e bitbucket_token="$BITBUCKET_TOKEN"
-#
-# Preconditions on the control node: git + Node (>=16) + npx, an SSH key authorized to
-# push to xsitesinc/web-client-area, and a Bitbucket API token with PR write access.
-- name: Onboard a Client Area brand (web-client-area)
-  hosts: localhost
-  connection: local
-  gather_facts: false
-
-  vars_prompt:
-    - name: brand_name
-      prompt: "Brand display name — used in the PR title (e.g. Zenith Horizon Group)"
-      private: false
-    - name: brand_assets_folder
-      prompt: "Brand assets folder name — the src/assets/other/<folder> (e.g. zenithhorizongroup); leave blank to derive from the display name"
-      default: ""
-      private: false
-    - name: jira_key
-      prompt: "Jira key (e.g. ATLP-47067)"
-      private: false
-    - name: dest_branches
-      prompt: "Destination branches, comma-separated (e.g. develop,master-26.9)"
-      private: false
-    - name: bitbucket_token
-      prompt: "Bitbucket API token"
-      private: true
-
-  roles:
-    - onboard_ca
+---
+# Onboard a Client Area brand into web-client-area and open the PR(s).
+#
+# Interactive:
+#   ansible-playbook onboard-ca.yml
+#
+# Non-interactive (e.g. from another playbook / CI), pass everything as extra-vars:
+#   ansible-playbook onboard-ca.yml \
+#     -e brand_name="Zenith Horizon Group" \
+#     -e brand_assets_folder=zenithhorizongroup \
+#     -e jira_key=ATLP-47067 \
+#     -e dest_branches=develop,master-26.9 \
+#     -e bitbucket_token="$BITBUCKET_TOKEN"
+#
+# Preconditions on the control node: git + Node (>=16) + npx, an SSH key authorized to
+# push to xsitesinc/web-client-area, and a Bitbucket API token with PR write access.
+- name: Onboard a Client Area brand (web-client-area)
+  hosts: localhost
+  connection: local
+  gather_facts: false
+
+  vars_prompt:
+    - name: brand_name
+      prompt: "Brand display name — used in the PR title (e.g. Zenith Horizon Group)"
+      private: false
+    - name: brand_assets_folder
+      prompt: "Brand assets folder name — the src/assets/other/<folder> (e.g. zenithhorizongroup); leave blank to derive from the display name"
+      default: ""
+      private: false
+    - name: jira_key
+      prompt: "Jira key (e.g. ATLP-47067)"
+      private: false
+    - name: dest_branches
+      prompt: "Destination branches, comma-separated (e.g. develop,master-26.9)"
+      private: false
+    - name: bitbucket_token
+      prompt: "Bitbucket API token"
+      private: true
+
+  roles:
+    - onboard_ca

package/ansible/onboarding-ca/roles/onboard_ca/defaults/main.yml

@@ -1,24 +1,24 @@
----
-# Pinned published antelope-cli version that provides the `onboarding-ca` command.
-antelope_cli_version: "1.2.0"
-
-# Where web-client-area is cloned on the control node.
-work_dir: "/tmp/onboard-ca/web-client-area"
-
-# Brand assets folder name (used for ENV_branding.brand_assets_folder and the src/assets/other/<folder>).
-# Empty => derived from brand_name (lowercased, spaces removed), matching antelope-cli's
-# connectedBrandName so the folder name is identical across repos.
-brand_assets_folder: ""
-
-# Reviewers for the PR. Empty => auto-fetched from the repo's Bitbucket "Default reviewers"
-# config (the authenticating account is excluded automatically). Override with an explicit
-# list, e.g. [{ account_id: "..." }] or [{ uuid: "{...}" }], to bypass the lookup.
-reviewers: []
-
-# Identity used for the commit (control-node git may have no global config).
-git_user_name: "Antelope Onboarding Bot"
-git_user_email: "devops@antelopesystem.com"
-
-# Bitbucket API token (Bearer) for the reviewer lookup + PR creation.
-# Provide via --extra-vars or Ansible Vault; never commit a real value.
-bitbucket_token: ""
+---
+# Pinned published antelope-cli version that provides the `onboarding-ca` command.
+antelope_cli_version: "1.2.0"
+
+# Where web-client-area is cloned on the control node.
+work_dir: "/tmp/onboard-ca/web-client-area"
+
+# Brand assets folder name (used for ENV_branding.brand_assets_folder and the src/assets/other/<folder>).
+# Empty => derived from brand_name (lowercased, spaces removed), matching antelope-cli's
+# connectedBrandName so the folder name is identical across repos.
+brand_assets_folder: ""
+
+# Reviewers for the PR. Empty => auto-fetched from the repo's Bitbucket "Default reviewers"
+# config (the authenticating account is excluded automatically). Override with an explicit
+# list, e.g. [{ account_id: "..." }] or [{ uuid: "{...}" }], to bypass the lookup.
+reviewers: []
+
+# Identity used for the commit (control-node git may have no global config).
+git_user_name: "Antelope Onboarding Bot"
+git_user_email: "devops@antelopesystem.com"
+
+# Bitbucket API token (Bearer) for the reviewer lookup + PR creation.
+# Provide via --extra-vars or Ansible Vault; never commit a real value.
+bitbucket_token: ""

package/ansible/onboarding-ca/roles/onboard_ca/meta/main.yml

@@ -1,10 +1,10 @@
----
-galaxy_info:
-  role_name: onboard_ca
-  author: Antelope Systems
-  description: >-
-    Onboard a Client Area brand: create the brand assets in web-client-area
-    (via antelope-cli onboarding-ca) and open the pull request(s).
-  license: ISC
-  min_ansible_version: "2.12"
-dependencies: []
+---
+galaxy_info:
+  role_name: onboard_ca
+  author: Antelope Systems
+  description: >-
+    Onboard a Client Area brand: create the brand assets in web-client-area
+    (via antelope-cli onboarding-ca) and open the pull request(s).
+  license: ISC
+  min_ansible_version: "2.12"
+dependencies: []

package/ansible/onboarding-ca/roles/onboard_ca/tasks/main.yml

@@ -1,76 +1,76 @@
----
-- name: Validate required inputs
-  ansible.builtin.assert:
-    that:
-      - brand_name is defined and (brand_name | length) > 0
-      - jira_key is defined and (jira_key | length) > 0
-      - dest_branches is defined and (dest_branches | length) > 0
-      - bitbucket_token is defined and (bitbucket_token | length) > 0
-    fail_msg: "brand_name, jira_key, dest_branches and bitbucket_token are all required."
-
-- name: Compute effective brand assets folder
-  ansible.builtin.set_fact:
-    brand_assets_folder: >-
-      {{ brand_assets_folder
-         if (brand_assets_folder | default('') | length) > 0
-         else (brand_name | lower | regex_replace(' ', '')) }}
-
-- name: Normalize destination branch list
-  ansible.builtin.set_fact:
-    dest_branch_list: "{{ dest_branches.split(',') | map('trim') | reject('equalto', '') | list }}"
-
-# --- Reviewers: pull from the repo's Bitbucket default-reviewers config -------------
-- name: Resolve reviewers from repo default-reviewers config
-  when: (reviewers | length) == 0
-  block:
-    - name: Identify the authenticating Bitbucket account (PR author)
-      ansible.builtin.uri:
-        url: "{{ api_base }}/user"
-        headers:
-          Authorization: "Bearer {{ bitbucket_token }}"
-        return_content: true
-      register: bb_user
-
-    - name: Fetch the repository default reviewers
-      ansible.builtin.uri:
-        url: "{{ api_base }}/repositories/{{ workspace }}/{{ repo_slug }}/default-reviewers?pagelen=100"
-        headers:
-          Authorization: "Bearer {{ bitbucket_token }}"
-        return_content: true
-      register: bb_default_reviewers
-
-    # Bitbucket rejects a PR whose author is also a reviewer, so drop the authenticating account.
-    # The REST API does not auto-apply default reviewers, so we pass them explicitly.
-    # Bitbucket's PR-create reviewers array is keyed by uuid; exclude the author by account_id.
-    - name: Build reviewers list (excluding the PR author)
-      ansible.builtin.set_fact:
-        reviewers: "{{ reviewers + [{'uuid': item.uuid}] }}"
-      loop: "{{ bb_default_reviewers.json['values'] }}"
-      when: item.account_id != bb_user.json.account_id
-      loop_control:
-        label: "{{ item.display_name | default(item.uuid) }}"
-
-- name: Ensure clone parent directory exists
-  ansible.builtin.file:
-    path: "{{ work_dir | dirname }}"
-    state: directory
-    mode: "0755"
-
-- name: Clone / refresh web-client-area over SSH
-  ansible.builtin.git:
-    repo: "{{ repo_ssh_url }}"
-    dest: "{{ work_dir }}"
-    version: "{{ dest_branch_list[0] }}"
-    update: true
-    force: true
-    accept_hostkey: true
-
-- name: Onboard the brand on each destination branch
-  ansible.builtin.include_tasks: per_branch.yml
-  loop: "{{ dest_branch_list }}"
-  loop_control:
-    loop_var: dest_branch
-
-- name: Summary of pull requests
-  ansible.builtin.debug:
-    msg: "{{ pr_results | default([]) }}"
+---
+- name: Validate required inputs
+  ansible.builtin.assert:
+    that:
+      - brand_name is defined and (brand_name | length) > 0
+      - jira_key is defined and (jira_key | length) > 0
+      - dest_branches is defined and (dest_branches | length) > 0
+      - bitbucket_token is defined and (bitbucket_token | length) > 0
+    fail_msg: "brand_name, jira_key, dest_branches and bitbucket_token are all required."
+
+- name: Compute effective brand assets folder
+  ansible.builtin.set_fact:
+    brand_assets_folder: >-
+      {{ brand_assets_folder
+         if (brand_assets_folder | default('') | length) > 0
+         else (brand_name | lower | regex_replace(' ', '')) }}
+
+- name: Normalize destination branch list
+  ansible.builtin.set_fact:
+    dest_branch_list: "{{ dest_branches.split(',') | map('trim') | reject('equalto', '') | list }}"
+
+# --- Reviewers: pull from the repo's Bitbucket default-reviewers config -------------
+- name: Resolve reviewers from repo default-reviewers config
+  when: (reviewers | length) == 0
+  block:
+    - name: Identify the authenticating Bitbucket account (PR author)
+      ansible.builtin.uri:
+        url: "{{ api_base }}/user"
+        headers:
+          Authorization: "Bearer {{ bitbucket_token }}"
+        return_content: true
+      register: bb_user
+
+    - name: Fetch the repository default reviewers
+      ansible.builtin.uri:
+        url: "{{ api_base }}/repositories/{{ workspace }}/{{ repo_slug }}/default-reviewers?pagelen=100"
+        headers:
+          Authorization: "Bearer {{ bitbucket_token }}"
+        return_content: true
+      register: bb_default_reviewers
+
+    # Bitbucket rejects a PR whose author is also a reviewer, so drop the authenticating account.
+    # The REST API does not auto-apply default reviewers, so we pass them explicitly.
+    # Bitbucket's PR-create reviewers array is keyed by uuid; exclude the author by account_id.
+    - name: Build reviewers list (excluding the PR author)
+      ansible.builtin.set_fact:
+        reviewers: "{{ reviewers + [{'uuid': item.uuid}] }}"
+      loop: "{{ bb_default_reviewers.json['values'] }}"
+      when: item.account_id != bb_user.json.account_id
+      loop_control:
+        label: "{{ item.display_name | default(item.uuid) }}"
+
+- name: Ensure clone parent directory exists
+  ansible.builtin.file:
+    path: "{{ work_dir | dirname }}"
+    state: directory
+    mode: "0755"
+
+- name: Clone / refresh web-client-area over SSH
+  ansible.builtin.git:
+    repo: "{{ repo_ssh_url }}"
+    dest: "{{ work_dir }}"
+    version: "{{ dest_branch_list[0] }}"
+    update: true
+    force: true
+    accept_hostkey: true
+
+- name: Onboard the brand on each destination branch
+  ansible.builtin.include_tasks: per_branch.yml
+  loop: "{{ dest_branch_list }}"
+  loop_control:
+    loop_var: dest_branch
+
+- name: Summary of pull requests
+  ansible.builtin.debug:
+    msg: "{{ pr_results | default([]) }}"