Skip to content

Commit 01b0e4c

Browse files
committed
fix: remove em dash
1 parent b1c8a6f commit 01b0e4c

19 files changed

Lines changed: 233 additions & 233 deletions

File tree

.github/ACT.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,35 +4,35 @@
44

55
**act** is a CLI that runs **GitHub Actions workflows on your computer** instead of on GitHub. It starts **Docker** containers that behave like GitHub’s `ubuntu-latest` runners, checks out your repo (or copies the working tree), and runs the same `run:` steps your YAML defines.
66

7-
You use it to **catch CI failures before you push**for example broken `plugin.json`, bad SKILL frontmatter, or failed skill checks.
7+
You use it to **catch CI failures before you push**-for example broken `plugin.json`, bad SKILL frontmatter, or failed skill checks.
88

99
## How it works (mental model)
1010

11-
1. **Event** You tell act what happened, e.g. `push` or `pull_request`. Many of our workflows are written for `on: push` / `pull_request`, so `act push` is the usual choice.
12-
2. **Workflow file** You pass **which YAML** to run with `-W .github/workflows/<file>.yml`. act does **not** read `on: paths:` the same way GitHub does; if you pass a file, act runs that workflow.
13-
3. **Jobs** act lists jobs with `act -l -W …`, then runs them in Docker when you use `act push -W …`.
14-
4. **Checkout** `actions/checkout` inside the container gets your project files (warnings like `unable to get git ref` are common until you have at least one git commit; the tree is still copied).
11+
1. **Event** - You tell act what happened, e.g. `push` or `pull_request`. Many of our workflows are written for `on: push` / `pull_request`, so `act push` is the usual choice.
12+
2. **Workflow file** - You pass **which YAML** to run with `-W .github/workflows/<file>.yml`. act does **not** read `on: paths:` the same way GitHub does; if you pass a file, act runs that workflow.
13+
3. **Jobs** - act lists jobs with `act -l -W …`, then runs them in Docker when you use `act push -W …`.
14+
4. **Checkout** - `actions/checkout` inside the container gets your project files (warnings like `unable to get git ref` are common until you have at least one git commit; the tree is still copied).
1515

1616
Nothing is sent to GitHub when you run act; it is **fully local** (except pulling Docker images the first time).
1717

1818
## Prerequisites
1919

2020
1. **Docker** running (`docker info` should succeed).
21-
2. **act** installed [releases](https://github.com/nektos/act/releases) or e.g. `brew install act`. Use **act ≥ 0.2.86** when possible (security fixes).
21+
2. **act** installed - [releases](https://github.com/nektos/act/releases) or e.g. `brew install act`. Use **act ≥ 0.2.86** when possible (security fixes).
2222

2323
## Run this repo’s CI locally (copy-paste)
2424

2525
From the **repository root**:
2626

27-
**Recommended all workflows (same as `task act`):**
27+
**Recommended - all workflows (same as `task act`):**
2828

2929
```bash
3030
./scripts/act-all.sh
3131
```
3232

33-
That script lists and runs **validate-plugin** and **test-skills** with `act push` (these **must** succeed the script exits non-zero if either fails). It then runs **semantic-pull-request** (`act pull_request` + [`.github/act/event-pull_request.json`](act/event-pull_request.json)) and **release-please** (`act push`) as **extra smoke tests**. Those two workflows call the **GitHub REST API** (`pulls.get`, release-please), so they **usually fail inside act** without a real `GITHUB_TOKEN`; that is expected and the script still exits **0** after the first two workflows pass.
33+
That script lists and runs **validate-plugin** and **test-skills** with `act push` (these **must** succeed - the script exits non-zero if either fails). It then runs **semantic-pull-request** (`act pull_request` + [`.github/act/event-pull_request.json`](act/event-pull_request.json)) and **release-please** (`act push`) as **extra smoke tests**. Those two workflows call the **GitHub REST API** (`pulls.get`, release-please), so they **usually fail inside act** without a real `GITHUB_TOKEN`; that is expected and the script still exits **0** after the first two workflows pass.
3434

35-
**Manual plugin + skills only:**
35+
**Manual - plugin + skills only:**
3636

3737
**1. See what would run (job names):**
3838

@@ -50,14 +50,14 @@ act push -W .github/workflows/test-skills.yml
5050

5151
Order does not matter between the two files; run both to match what CI exercises for plugin + skills.
5252

53-
**Manual semantic PR workflow (`pull_request`):**
53+
**Manual - semantic PR workflow (`pull_request`):**
5454

5555
```bash
5656
act -l -W .github/workflows/semantic-pull-request.yml
5757
act pull_request -W .github/workflows/semantic-pull-request.yml -e .github/act/event-pull_request.json
5858
```
5959

60-
**Manual release-please (`push` to `main`):**
60+
**Manual - release-please (`push` to `main`):**
6161

6262
```bash
6363
act -l -W .github/workflows/release-please.yml
@@ -83,9 +83,9 @@ If you use [Task](https://taskfile.dev/), [`Taskfile.yaml`](../Taskfile.yaml) de
8383

8484
| Topic | On GitHub | With act |
8585
| --- | --- | --- |
86-
| `paths:` filters | Workflow may be skipped if paths don’t match | Ignored for “should this run?” you chose the file with `-W` |
86+
| `paths:` filters | Workflow may be skipped if paths don’t match | Ignored for “should this run?” - you chose the file with `-W` |
8787
| Runners | GitHub-hosted Ubuntu | Docker image (e.g. `ghcr.io/catthehacker/ubuntu:act-latest`) |
88-
| **`GITHUB_TOKEN`** | Injected automatically for each job as `secrets.GITHUB_TOKEN` (scoped to the repo, permissions from the workflow `permissions:` block). You do **not** add it under **Settings → Secrets**. | **Not** the same as GitHub’s token. act may set a placeholder or empty value; it does **not** mint a real token that can call `api.github.com` like the hosted runner. To exercise API-using actions locally you must pass a token yourself (e.g. `act … -s GITHUB_TOKEN=…` with a fine-scoped PAT)optional and easy to get wrong, so we treat API workflows as **CI-only** for “full success.” |
88+
| **`GITHUB_TOKEN`** | Injected automatically for each job as `secrets.GITHUB_TOKEN` (scoped to the repo, permissions from the workflow `permissions:` block). You do **not** add it under **Settings → Secrets**. | **Not** the same as GitHub’s token. act may set a placeholder or empty value; it does **not** mint a real token that can call `api.github.com` like the hosted runner. To exercise API-using actions locally you must pass a token yourself (e.g. `act … -s GITHUB_TOKEN=…` with a fine-scoped PAT)-optional and easy to get wrong, so we treat API workflows as **CI-only** for “full success.” |
8989
| `import yaml` in Python | Works after we install **`python3-yaml`** via `apt` in the workflow | Same; that step exists so act matches GitHub |
9090
| **release-please** / **semantic PR** actions | Full GitHub API + real `GITHUB_TOKEN` | May fail or partially run without a PAT; use for YAML/container smoke tests |
9191

@@ -100,5 +100,5 @@ If you use [Task](https://taskfile.dev/), [`Taskfile.yaml`](../Taskfile.yaml) de
100100

101101
## See also
102102

103-
- [CONTRIBUTING.md Development setup](../CONTRIBUTING.md#optional-run-ci-workflows-locally-with-act)
103+
- [CONTRIBUTING.md - Development setup](../CONTRIBUTING.md#optional-run-ci-workflows-locally-with-act)
104104
- [GitHub: Workflow syntax](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions)

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ assignees: []
3333

3434
## Additional context
3535

36-
<!-- Logs, screenshots, links do not paste secrets, tokens, or real record UIDs -->
36+
<!-- Logs, screenshots, links - do not paste secrets, tokens, or real record UIDs -->

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ blank_issues_enabled: true
22
contact_links:
33
- name: Keeper Security product support
44
url: https://keepersecurity.com/support
5-
about: Account, vault, KSM, or Commander product issues use official support, not this repo.
5+
about: Account, vault, KSM, or Commander product issues - use official support, not this repo.

CHANGELOG.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
88

99
### Added
1010

11-
- **Skills** Three agent skills with reference documentation under `skills/*/references/`:
12-
- `keeper-secrets` KSM CLI (`ksm`): secrets retrieval, `ksm exec`, `ksm interpolate`, Keeper notation, Docker/Kubernetes/CI patterns.
13-
- `keeper-admin` Keeper Commander (`keeper`): vault, enterprise admin, PAM, rotation, and related command references.
14-
- `keeper-setup` Installing and configuring the KSM and Commander CLIs, regions, and troubleshooting.
15-
- **Distribution** Claude Code plugin metadata (`.claude-plugin/`), marketplace listing, and install paths via [Vercel Skills CLI](https://github.com/vercel-labs/skills) (`npx skills add`) or manual copy into an agent’s skills directory.
16-
- **Documentation** README, CONTRIBUTING, SECURITY, `TEST_PROMPTS.md`, and links to official Keeper docs (Secrets Manager overview, Commander overview, Keeper notation).
17-
- **CI** GitHub Actions workflows to validate plugin JSON, marketplace JSON, SKILL frontmatter, reference files, and skill trigger/content checks; `python3-yaml` installed in workflows for reliable frontmatter parsing locally and on runners.
18-
- **Developer tooling** `Taskfile` tasks for Markdown (`task fmt`), dependencies (`task install`), and running CI locally with [act](https://github.com/nektos/act) (`task act`); [`.github/ACT.md`](.github/ACT.md) documents local workflow runs.
19-
- **Community** Issue templates, pull request template, `CODEOWNERS`, Apache 2.0 [`LICENSE.md`](LICENSE.md).
11+
- **Skills** - Three agent skills with reference documentation under `skills/*/references/`:
12+
- `keeper-secrets` - KSM CLI (`ksm`): secrets retrieval, `ksm exec`, `ksm interpolate`, Keeper notation, Docker/Kubernetes/CI patterns.
13+
- `keeper-admin` - Keeper Commander (`keeper`): vault, enterprise admin, PAM, rotation, and related command references.
14+
- `keeper-setup` - Installing and configuring the KSM and Commander CLIs, regions, and troubleshooting.
15+
- **Distribution** - Claude Code plugin metadata (`.claude-plugin/`), marketplace listing, and install paths via [Vercel Skills CLI](https://github.com/vercel-labs/skills) (`npx skills add`) or manual copy into an agent’s skills directory.
16+
- **Documentation** - README, CONTRIBUTING, SECURITY, `TEST_PROMPTS.md`, and links to official Keeper docs (Secrets Manager overview, Commander overview, Keeper notation).
17+
- **CI** - GitHub Actions workflows to validate plugin JSON, marketplace JSON, SKILL frontmatter, reference files, and skill trigger/content checks; `python3-yaml` installed in workflows for reliable frontmatter parsing locally and on runners.
18+
- **Developer tooling** - `Taskfile` tasks for Markdown (`task fmt`), dependencies (`task install`), and running CI locally with [act](https://github.com/nektos/act) (`task act`); [`.github/ACT.md`](.github/ACT.md) documents local workflow runs.
19+
- **Community** - Issue templates, pull request template, `CODEOWNERS`, Apache 2.0 [`LICENSE.md`](LICENSE.md).
2020

2121
[1.0.0]: https://github.com/Keeper-Security/agent-kit/releases/tag/v1.0.0

CONTRIBUTING.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ This repo is Markdown-only (no build step for the skills themselves). To run the
7373

7474
### Required: Task and Cargo
7575

76-
1. **[Task](https://taskfile.dev/installation/)** install the `task` CLI so you can run tasks from [`Taskfile.yaml`](Taskfile.yaml) (`task fmt`, `task install`, etc.).
77-
2. **[Rust and Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html)** required because `task install` uses [cargo-binstall](https://github.com/cargo-bins/cargo-binstall) to pull prebuilt binaries (e.g. [rumdl](https://github.com/rvben/rumdl)).
76+
1. **[Task](https://taskfile.dev/installation/)** - install the `task` CLI so you can run tasks from [`Taskfile.yaml`](Taskfile.yaml) (`task fmt`, `task install`, etc.).
77+
2. **[Rust and Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html)** - required because `task install` uses [cargo-binstall](https://github.com/cargo-bins/cargo-binstall) to pull prebuilt binaries (e.g. [rumdl](https://github.com/rvben/rumdl)).
7878

7979
Then clone and install dev tools:
8080

@@ -113,9 +113,9 @@ Pull requests are checked by **Semantic PR** (`.github/workflows/semantic-pull-r
113113

114114
#### `version.txt` (how the version is updated)
115115

116-
- **Role** One line, semver only (e.g. `1.2.3`). With **`release-type: simple`** in `release-please-config.json`, this file is the **canonical project version** release-please reads and writes.
117-
- **Normal workflow** **Do not** edit `version.txt` by hand to ship a release. Land conventional commits on `main`, let release-please open its **release PR**, review it, and **merge that PR**. The PR updates `version.txt` together with `.release-please-manifest.json`, `CHANGELOG.md`, and the `version` fields in `.claude-plugin/plugin.json` and `marketplace.json` (see `extra-files` in `release-please-config.json`).
118-
- **Avoid drift** If you ever change a version **outside** that flow (unusual), update **every** file release-please keeps in sync so they all match; mismatches break automation and CI expectations.
116+
- **Role** - One line, semver only (e.g. `1.2.3`). With **`release-type: simple`** in `release-please-config.json`, this file is the **canonical project version** release-please reads and writes.
117+
- **Normal workflow** - **Do not** edit `version.txt` by hand to ship a release. Land conventional commits on `main`, let release-please open its **release PR**, review it, and **merge that PR**. The PR updates `version.txt` together with `.release-please-manifest.json`, `CHANGELOG.md`, and the `version` fields in `.claude-plugin/plugin.json` and `marketplace.json` (see `extra-files` in `release-please-config.json`).
118+
- **Avoid drift** - If you ever change a version **outside** that flow (unusual), update **every** file release-please keeps in sync so they all match; mismatches break automation and CI expectations.
119119

120120
### Optional: run CI workflows locally with [act](https://github.com/nektos/act)
121121

@@ -276,30 +276,30 @@ ksm secret list
276276

277277
Focus on:
278278

279-
- **When to use** Clarify skill purpose and when agent should use it
280-
- **Prerequisites** What users need before using
281-
- **Core concepts** Key ideas explained simply
282-
- **Common patterns** Most used workflows
283-
- **Guardrails** Security and safety guidelines
279+
- **When to use** - Clarify skill purpose and when agent should use it
280+
- **Prerequisites** - What users need before using
281+
- **Core concepts** - Key ideas explained simply
282+
- **Common patterns** - Most used workflows
283+
- **Guardrails** - Security and safety guidelines
284284

285285
### Reference Files
286286

287287
Focus on:
288288

289-
- **Complete reference** All commands and options
290-
- **Examples** Real-world usage patterns
291-
- **Troubleshooting** Common issues and solutions
292-
- **Best practices** Recommended approaches
289+
- **Complete reference** - All commands and options
290+
- **Examples** - Real-world usage patterns
291+
- **Troubleshooting** - Common issues and solutions
292+
- **Best practices** - Recommended approaches
293293

294294
## Versioning
295295

296-
**Plugin / repo version** [release-please](https://github.com/googleapis/release-please) manages **one** semver for the whole distribution: `version.txt`, `.release-please-manifest.json`, `CHANGELOG.md`, and the `version` fields in **`.claude-plugin/plugin.json`** and **`.claude-plugin/marketplace.json`** (see `release-please-config.json``extra-files`). It does **not** bump per-skill versions; skills under `skills/` ship as part of that plugin release.
296+
**Plugin / repo version** - [release-please](https://github.com/googleapis/release-please) manages **one** semver for the whole distribution: `version.txt`, `.release-please-manifest.json`, `CHANGELOG.md`, and the `version` fields in **`.claude-plugin/plugin.json`** and **`.claude-plugin/marketplace.json`** (see `release-please-config.json``extra-files`). It does **not** bump per-skill versions; skills under `skills/` ship as part of that plugin release.
297297

298298
**Change significance** (for commit messages and changelog tone; not separate skill semver in this repo):
299299

300-
- **MAJOR** Breaking changes to command syntax or CLI
301-
- **MINOR** New features, new commands, additions
302-
- **PATCH** Documentation fixes, clarifications, typos
300+
- **MAJOR** - Breaking changes to command syntax or CLI
301+
- **MINOR** - New features, new commands, additions
302+
- **PATCH** - Documentation fixes, clarifications, typos
303303

304304
## License
305305

0 commit comments

Comments
 (0)