Skip to content

Commit bc02a2d

Browse files
WEBSITE: Added starter prompt for AI coding assistant
1 parent 5b79226 commit bc02a2d

3 files changed

Lines changed: 75 additions & 0 deletions

File tree

WORKFLOWS.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Workflows
2+
3+
This document describes the GitHub Actions workflows and common development procedures for promptopskit.
4+
5+
## GitHub Actions
6+
7+
### CI (`.github/workflows/ci.yml`)
8+
9+
Runs on every push to `main` and on pull requests (ignoring docs/website/markdown changes).
10+
11+
- Tests against Node 20 and 22
12+
- Steps: `npm ci``lint``test``build``publint``attw`
13+
14+
### Publish (`.github/workflows/publish.yml`)
15+
16+
Runs automatically when a tag matching `v*` is pushed.
17+
18+
- Steps: `npm ci``lint``test``build``publint``attw``npm publish --access public`
19+
- Publishes to npm using the repository's `NODE_AUTH_TOKEN` secret
20+
21+
**Do not run `npm publish` locally.** The Action handles it.
22+
23+
### Deploy Website (`.github/workflows/website.yml`)
24+
25+
Runs when `website/` or `docs/` files change on `main`, or via manual dispatch.
26+
27+
- Copies `docs/*.md` into `website/docs/`
28+
- Syncs the `website/` directory to S3
29+
- Invalidates the CloudFront cache
30+
31+
## Publishing a New Version
32+
33+
1. Make sure you're on `main` with a clean working tree.
34+
35+
2. Bump the version:
36+
```sh
37+
npm version patch # bug fixes (0.1.1 → 0.1.2)
38+
npm version minor # new features (0.1.1 → 0.2.0)
39+
npm version major # breaking changes (0.1.1 → 1.0.0)
40+
```
41+
This updates `package.json`, creates a git commit, and creates a `v*` tag.
42+
43+
3. Push the commit and tag:
44+
```sh
45+
git push && git push --tags
46+
```
47+
48+
4. The **Publish** Action triggers automatically, runs all checks, and publishes to npm.
49+
50+
5. Monitor the run at https://github.com/PredictabilityAtScale/promptopskit/actions to confirm it succeeds.
51+
52+
That's it — three commands: `npm version`, `git push`, `git push --tags`.

website/index.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,10 @@ <h3>1. Install and scaffold</h3>
162162
<pre><code>npm install promptopskit
163163
npx promptopskit init ./prompts</code></pre>
164164
<p>Creates a <code>prompts/</code> directory with starter files and a shared instructions folder.</p>
165+
<details class="ai-prompt-tip">
166+
<summary>Or, give this prompt to your AI coding assistant</summary>
167+
<pre><code>Install promptopskit, run `npx promptopskit init ./prompts` to scaffold starter prompt files, and add a "build:prompts": "promptopskit compile ./prompts ./dist/prompts" script to package.json.</code></pre>
168+
</details>
165169
</article>
166170

167171
<article class="card">

website/styles.css

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -212,6 +212,25 @@ ul {
212212
font-size: 0.95rem;
213213
}
214214

215+
.ai-prompt-tip {
216+
margin-top: 0.75rem;
217+
border: 1px dashed var(--line);
218+
border-radius: 6px;
219+
padding: 0.5rem 0.75rem;
220+
font-size: 0.9rem;
221+
}
222+
223+
.ai-prompt-tip summary {
224+
cursor: pointer;
225+
color: var(--muted);
226+
font-weight: 500;
227+
}
228+
229+
.ai-prompt-tip pre {
230+
margin-top: 0.5rem;
231+
white-space: pre-wrap;
232+
}
233+
215234
@media (max-width: 900px) {
216235
nav {
217236
display: none;

0 commit comments

Comments
 (0)