Perform code optimization and document cleanup (#1)
## Summary - add repository-wide quality tooling and verification scaffolding, including CI workflows, pnpm workspace setup, ESLint/Prettier/markdown checks, and generated-output verification helpers - reorganize skill sources and generation flow by introducing canonical `_source` variants, generator/manifests, reusable helper abstractions, and shared web-automation/browser utilities - clean up and expand documentation so the root README flows into docs and skill docs, with clearer development, reviewer, installer, and workflow guidance ## Notable changes - docs flow and consistency cleanup across `README.md`, `docs/README.md`, and related docs - new scripts for `check`, docs verification, generated-file verification, shell portability, and safe directory replacement - refactors in Atlassian and web-automation skill runtimes to reduce duplication and centralize reusable code - changelog, development documentation, and CI surface updates ## Test Plan - [ ] `pnpm run check` - [ ] review generated/manifests and skill sync outputs - [ ] smoke-check docs flow from `README.md` to `docs/README.md` to skill docs ## Notes - this branch currently includes tracked `skills/web-automation/shared/node_modules` content that should be reviewed carefully as potentially noisy/accidental committed artifacts Co-authored-by: Stefano Fiorini <stefano.fiorini@firsthorizon.com> Reviewed-on: #1
This commit was merged in pull request #1.
This commit is contained in:
+16
-8
@@ -2,13 +2,17 @@
|
||||
|
||||
## Purpose
|
||||
|
||||
Provide a portable Atlassian Cloud skill for Codex, Claude Code, Cursor Agent, OpenCode, and Pi using one shared CLI surface for common Jira and Confluence workflows.
|
||||
Provide a portable Atlassian Cloud skill for Codex, Claude Code, Cursor Agent, OpenCode, and Pi
|
||||
using one shared CLI surface for common Jira and Confluence workflows.
|
||||
|
||||
## Why This Skill Exists
|
||||
|
||||
The repo targets multiple agent environments with uneven MCP availability. This skill packages a consistent CLI contract so the same task-oriented workflows can be used across all supported agents without depending on MCP-specific integrations.
|
||||
The repo targets multiple agent environments with uneven MCP availability. This skill packages a
|
||||
consistent CLI contract so the same task-oriented workflows can be used across all supported agents
|
||||
without depending on MCP-specific integrations.
|
||||
|
||||
The canonical runtime lives in `skills/atlassian/shared/scripts/`. Installable per-agent `scripts/` bundles are generated from that source with:
|
||||
The canonical runtime lives in `skills/atlassian/shared/scripts/`. Installable per-agent
|
||||
`scripts/` bundles are generated from that source with:
|
||||
|
||||
```bash
|
||||
pnpm --dir skills/atlassian/shared/scripts sync:agents
|
||||
@@ -23,7 +27,8 @@ pnpm --dir skills/atlassian/shared/scripts sync:agents
|
||||
- `ATLASSIAN_EMAIL`
|
||||
- `ATLASSIAN_API_TOKEN`
|
||||
|
||||
The `ATLASSIAN_*` values may come from the shell environment or a `.env` file in the installed agent-specific `scripts/` folder.
|
||||
The `ATLASSIAN_*` values may come from the shell environment or a `.env` file in the installed
|
||||
agent-specific `scripts/` folder.
|
||||
|
||||
Optional:
|
||||
|
||||
@@ -52,12 +57,15 @@ Optional:
|
||||
|
||||
## Command Notes
|
||||
|
||||
- `health` validates local configuration, probes Jira and Confluence separately, and reports one product as unavailable without masking the other.
|
||||
- `health` validates local configuration, probes Jira and Confluence separately, and reports one
|
||||
product as unavailable without masking the other.
|
||||
- `jira-create` requires `--type`, `--summary`, and either `--project` or `ATLASSIAN_DEFAULT_PROJECT`.
|
||||
- `jira-update` requires `--issue` and at least one of `--summary` or `--description-file`.
|
||||
- `conf-create` requires `--title`, `--body-file`, and either `--space` or `ATLASSIAN_DEFAULT_SPACE`.
|
||||
- `conf-update` requires `--page`, `--title`, and `--body-file`; it fetches the current page version before building the update payload.
|
||||
- `raw --body-file` expects a workspace-scoped JSON file and is limited to validated Atlassian API prefixes.
|
||||
- `conf-update` requires `--page`, `--title`, and `--body-file`; it fetches the current page
|
||||
version before building the update payload.
|
||||
- `raw --body-file` expects a workspace-scoped JSON file and is limited to validated Atlassian
|
||||
API prefixes.
|
||||
|
||||
## Safety Model
|
||||
|
||||
@@ -130,7 +138,7 @@ Recommended full Pi package install:
|
||||
Manual single-skill Pi install from the package mirror:
|
||||
|
||||
```bash
|
||||
./scripts/sync-pi-package-skills.sh
|
||||
pnpm run sync:pi
|
||||
mkdir -p .pi/skills/atlassian
|
||||
cp -R pi-package/skills/atlassian/* .pi/skills/atlassian/
|
||||
cd .pi/skills/atlassian/scripts
|
||||
|
||||
Reference in New Issue
Block a user