Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions PLUGINS.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ React component development — coding standards, testing, and structure
| Skill | Description |
|-------|-------------|
| `pf-component-structure` | Audit PatternFly React component nesting, wrapper hierarchies, and layout structure. |
| `pf-github-pages-deploy` | Deploy a PatternFly React project to GitHub Pages using pfcli deploy. |
| `pf-import-checker` | Audit and fix invalid PatternFly import paths across packages. |
| `pf-project-scaffolder` | Scaffolds PatternFly React projects with PF6-safe dependencies, imports, and starter layout. |
| `pf-prototype-mode` | Enable prototype mode for React apps with grayscale styling and a banner overlay. |
Expand Down
3 changes: 3 additions & 0 deletions plugins/react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ Skills are tasks that produce a result.

**PF Prototype Mode** (`/react:pf-prototype-mode`) — Rapid prototyping mode for quickly building PatternFly UI layouts.

**PF GitHub Pages Deploy** (`/react:pf-github-pages-deploy`) — Builds and deploys a PatternFly React app to GitHub Pages with `pfcli deploy`.

### Agents

Agents are domain knowledge the AI follows.
Expand Down Expand Up @@ -78,6 +80,7 @@ react/
│ └── pf-unit-test-standards.md
├── skills/
│ ├── pf-component-structure/
│ ├── pf-github-pages-deploy/
│ ├── pf-import-checker/
│ ├── pf-project-scaffolder/
│ ├── pf-prototype-mode/
Expand Down
101 changes: 101 additions & 0 deletions plugins/react/skills/pf-github-pages-deploy/SKILL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
---
name: pf-github-pages-deploy
description: Deploy a PatternFly React project to GitHub Pages using pfcli deploy. Use when publishing a prototype, sharing a demo URL, deploying to GitHub Pages, or when the user mentions pfcli deploy.
---
Comment on lines +1 to +4

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical | ⚡ Quick win

Critical: Add disable-model-invocation: true to frontmatter.

This skill executes pfcli deploy which deploys to GitHub Pages—a side-effecting operation. Per PatternFly coding guidelines and documented convention, SKILL.md frontmatter must include disable-model-invocation: true for any skill that performs deployments, writes files, creates issues, or posts external content. Omitting this flag creates a security risk by allowing unintended programmatic invocation of the deploy command.

🔒 Proposed fix to add the disable-model-invocation flag
 ---
 name: pf-github-pages-deploy
 description: Deploy a PatternFly React project to GitHub Pages using pfcli deploy. Use when publishing a prototype, sharing a demo URL, deploying to GitHub Pages, or when the user mentions pfcli deploy.
+disable-model-invocation: true
 ---
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@plugins/react/skills/pf-github-pages-deploy/SKILL.md` around lines 1 - 4, The
SKILL.md frontmatter is missing the required `disable-model-invocation: true`
flag. Since the pf-github-pages-deploy skill executes a side-effecting operation
(deploying to GitHub Pages), you must add `disable-model-invocation: true` to
the YAML frontmatter block between the dashes at the top of the file, alongside
the existing name and description fields. This flag prevents unintended
programmatic invocation of the deploy command and aligns with PatternFly coding
guidelines for skills that perform deployments or other external operations.

Sources: Coding guidelines, Learnings

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just agreeing with the coderabbit comment. CONTRIBUTING-SKILLS.md calls this out specifically for skills that deploy. Without it, the AI could auto-invoke a deployment when someone casually mentions "deploy" or "GitHub Pages."


# Deploy to GitHub Pages with pfcli

Build the project and publish it to GitHub Pages with a single command. `pfcli deploy` runs the build, configures asset paths for project pages, enables GitHub Pages when possible, and pushes to the `gh-pages` branch.

## Prerequisites

Verify before deploying:

1. **PatternFly CLI** — `pfcli --version` or `patternfly-cli --version`. If missing, install from [patternfly/patternfly-cli](https://github.com/patternfly/patternfly-cli).
2. **GitHub CLI** — `gh auth status` must show a logged-in account with repo access.
3. **Git remote** — the project must have an `origin` remote pointing at GitHub (`git remote get-url origin`). If missing, run `pfcli init` first.
4. **Build script** — `package.json` must define a `build` script unless deploying prebuilt output with `--no-build`.

Run from the project root (or pass the path as the final argument).

## Deploy workflow

```text
Task progress:
- [ ] Confirm prerequisites
- [ ] Commit or stash uncommitted work if the user wants a clean deploy
- [ ] Run pfcli deploy
- [ ] Share the live URL with the user
```

### Step 1: Confirm the project is ready

From the project root:

```bash
test -f package.json && git remote get-url origin
gh auth status
```

If there is no GitHub remote, run `pfcli init` in the project directory and follow its prompts to create or connect a repository.

If the user has uncommitted changes they want on GitHub before deploying, run `pfcli save` first.

### Step 2: Deploy

Default deploy (build + publish `dist/` to `gh-pages`):

```bash
pfcli deploy
```

Common options:

| Flag | Purpose |
|------|---------|
| `-d, --dist-dir <dir>` | Output folder (default: `dist`) |
| `--no-build` | Deploy existing build output only |
| `-b, --branch <branch>` | Deploy branch (default: `gh-pages`) |
| `--base <path>` | Override public asset path (default: derived from repo name) |

Examples:

```bash
# Deploy a project in another directory
pfcli deploy ./my-app

# CRA or webpack output in build/
pfcli deploy -d build

# Skip build when dist/ is already built
pfcli deploy --no-build

# User/org site served from root (e.g. owner.github.io)
pfcli deploy --base /
```

For project repos (`github.com/owner/my-app`), `pfcli deploy` automatically sets Vite `--base`, webpack `ASSET_PATH`, or CRA `PUBLIC_URL` to `/<repo>/`.

If the app uses React Router, remind the user to set `basename` to match the public path (e.g. `<BrowserRouter basename="/my-app">`).

### Step 3: Share the result

On success, the CLI prints the live URL:

- Project page: `https://<owner>.github.io/<repo>/`
- User/org page: `https://<owner>.github.io/`

Tell the user the URL may take a minute to update on first deploy. If Pages is not enabled, they can set **Settings → Pages → Source** to the `gh-pages` branch.

## Troubleshooting

| Error | Likely cause | Fix |
|-------|--------------|-----|
| `Please save your changes first...` | No `origin` remote | Run `pfcli init` or add `git remote add origin ...` |
| `No package.json found` | Wrong directory | `cd` to project root or pass the path |
| `No "build" script found` | Missing build script | Add `"build"` to `package.json` or use `--no-build -d <dir>` |
| `Build output directory "dist" does not exist` | Wrong output dir or failed build | Fix the build or pass `-d` with the correct folder |
| Blank page or missing assets | Wrong base path | Re-deploy; for custom hosting use `--base /<repo>/` |
| `gh auth` failures | GitHub CLI not authenticated | Run `gh auth login` |

Do not manually configure GitHub Actions or gh-pages npm scripts when `pfcli deploy` is available — the CLI handles build env vars, SPA `404.html`, and Pages setup.