Publish and Deploy

AI prompts to help you package, publish, and maintain your NaaP plugin in the marketplace.

When to Use This#

Use these prompts when:

Your plugin is ready and you want to publish it
You need help writing a README or changelog
You want to set up CI/CD for automatic publishing
You need to update or version your plugin

Prompt: Prepare for Publishing#

Markdown

1	# Task: Prepare My NaaP Plugin for Publishing
2
3	## Context
4
5	NaaP plugins are published to the NaaP marketplace. Before publishing,
6	the plugin needs to be properly configured, documented, and validated.
7
8	Publishing checklist:
9	1. plugin.json has all required fields (name, displayName, version, description, category, author)
10	2. Frontend builds successfully with `npm run build:umd`
11	3. Backend builds successfully with `npm run build` (if full-stack)
12	4. `naap-plugin doctor` passes all checks
13	5. README.md exists with usage documentation
14	6. CHANGELOG.md exists with version history
15	7. assets/icon.png exists (256x256, plugin icon for marketplace)
16
17	## My Plugin
18
19	Plugin name: [YOUR_PLUGIN_NAME]
20	Type: [frontend-only / full-stack]
21	Version: 1.0.0
22
23	Current plugin.json:
24	[PASTE YOUR plugin.json]
25
26	## Please Generate
27
28	1. Updated plugin.json — review and fix any issues, add missing fields
29
30	2. README.md — professional README with:
31	- Plugin description and screenshots section
32	- Features list
33	- Installation instructions
34	- Configuration options
35	- Usage guide
36	- API documentation (if full-stack)
37	- Contributing section
38	- License (MIT)
39
40	3. CHANGELOG.md — initial changelog:
41	```markdown
42	# Changelog
43
44	## [1.0.0] - [TODAY'S DATE]
45	### Added
46	- Initial release
47	- [LIST KEY FEATURES]

Pre-publish validation script — a shell script that:
- Runs linting
- Runs tests
- Builds frontend and backend
- Runs naap-plugin doctor
- Reports any issues
package.json scripts — ensure these scripts exist:
- build:umd (frontend)
- build (backend, if applicable)
- test
- lint
- doctor (runs naap-plugin doctor)
- prepublish (runs build + test + doctor)

1
2	## Prompt: Write Plugin Documentation
3
4	```markdown
5	# Task: Write Documentation for My NaaP Plugin
6
7	## Context
8
9	I want to publish documentation for my NaaP plugin so other users
10	know how to install, configure, and use it. NaaP supports plugin
11	documentation published to the community docs section.
12
13	## My Plugin
14
15	Plugin name: [YOUR_PLUGIN_NAME]
16	Description: [WHAT DOES YOUR PLUGIN DO]
17
18	Features:
19	[LIST ALL FEATURES — for example:
20	- Real-time task tracking with drag-and-drop Kanban board
21	- Team assignments and workload visualization
22	- Due date reminders and notifications
23	- CSV/JSON export
24	- Customizable columns and labels
25	]
26
27	Configuration options:
28	[LIST ANY SETTINGS — for example:
29	- Default view (Kanban / List / Table)
30	- Notification preferences
31	- Color theme for labels
32	]
33
34	API endpoints (if full-stack):
35	[LIST YOUR API ENDPOINTS]
36
37	## Generate
38
39	1. User-facing documentation (docs/README.md):
40	- Getting started guide
41	- Feature walkthrough with descriptions
42	- Configuration guide
43	- FAQ section
44	- Troubleshooting section
45
46	2. Developer documentation (docs/DEVELOPER.md):
47	- Architecture overview
48	- Local development setup
49	- API reference (if backend exists)
50	- Contributing guidelines
51	- Code style guide
52
53	3. MDX documentation page for the NaaP docs site (docs/plugin-doc.mdx):
54	- Frontmatter with title, description
55	- Overview section
56	- Installation section
57	- Usage guide with code examples
58	- Configuration reference
59	- Written in MDX format with proper headings
60
61	Write in a friendly, professional tone. Include code examples where helpful.

Prompt: Set Up CI/CD#

Markdown

1	# Task: Set Up CI/CD for My NaaP Plugin
2
3	## Context
4
5	I want to set up GitHub Actions to automatically test, build, and
6	optionally publish my NaaP plugin when I push to the repository.
7
8	## My Plugin
9
10	Plugin name: [YOUR_PLUGIN_NAME]
11	Type: [frontend-only / full-stack]
12	Repository: [github.com/YOUR_USERNAME/YOUR_REPO]
13
14	## Generate GitHub Actions Workflows
15
16	1. CI Workflow (.github/workflows/ci.yml):
17	- Triggers on: push to main, pull requests
18	- Steps:
19	- Checkout code
20	- Setup Node.js 20
21	- Install dependencies
22	- Run linting
23	- Run tests
24	- Build frontend (npm run build:umd)
25	- Build backend (if full-stack)
26	- Run naap-plugin doctor
27	- Report status as GitHub check
28
29	2. Publish Workflow (.github/workflows/publish.yml):
30	- Triggers on: GitHub Release created
31	- Steps:
32	- Run full CI checks
33	- Package plugin (naap-plugin package)
34	- Publish to NaaP marketplace (naap-plugin publish)
35	- Uses NAAP_AUTH_TOKEN secret for authentication
36
37	3. PR Preview Workflow (.github/workflows/preview.yml):
38	- Triggers on: pull request
39	- Runs tests and build
40	- Comments on PR with build status and size
41
42	Generate complete workflow YAML files.

Publishing Commands#

After the AI helps you prepare everything:

Terminal

# 1. Validate everything

$naap-plugin doctor

# 2. Build the plugin

$cd frontend && npm run build:umd

$cd ../backend && npm run build # if full-stack

# 3. Package it

$naap-plugin package

# Creates: [plugin-name]-1.0.0.naap-plugin

# 4. Log in to the marketplace

$naap-plugin login

# Follow the authentication flow

# 5. Publish!

$naap-plugin publish

# 6. Verify it's live

# Visit the marketplace in the NaaP shell

Prompt: Version and Update#

When you want to release a new version:

Markdown

1	# Task: Prepare a New Version of My NaaP Plugin
2
3	## Current Version: [e.g., 1.0.0]
4	## New Version: [e.g., 1.1.0]
5
6	## Changes Since Last Release
7
8	[DESCRIBE WHAT CHANGED — for example:
9	- Added dark mode support
10	- Fixed a bug where tasks wouldn't save
11	- Improved loading performance
12	- Added CSV export feature
13	]
14
15	## Please Generate
16
17	1. Updated version in plugin.json (and any package.json files)
18
19	2. CHANGELOG.md entry for the new version:
20	- Group changes by: Added, Changed, Fixed, Removed
21	- Follow Keep a Changelog format
22
23	3. Migration notes (if there are breaking changes):
24	- What changed
25	- How to update
26	- Any data migration needed
27
28	4. Updated README.md (if new features need documentation)
29
30	5. A git commit message and tag command:
31	```bash
32	git add .
33	git commit -m "release: v[NEW_VERSION]"
34	git tag v[NEW_VERSION]
35	git push && git push --tags

Publish and Deploy

AI prompts to help you package, publish, and maintain your NaaP plugin in the marketplace.

When to Use This#

Use these prompts when:

Your plugin is ready and you want to publish it
You need help writing a README or changelog
You want to set up CI/CD for automatic publishing
You need to update or version your plugin

Prompt: Prepare for Publishing#

Markdown

1	# Task: Prepare My NaaP Plugin for Publishing
2
3	## Context
4
5	NaaP plugins are published to the NaaP marketplace. Before publishing,
6	the plugin needs to be properly configured, documented, and validated.
7
8	Publishing checklist:
9	1. plugin.json has all required fields (name, displayName, version, description, category, author)
10	2. Frontend builds successfully with `npm run build:umd`
11	3. Backend builds successfully with `npm run build` (if full-stack)
12	4. `naap-plugin doctor` passes all checks
13	5. README.md exists with usage documentation
14	6. CHANGELOG.md exists with version history
15	7. assets/icon.png exists (256x256, plugin icon for marketplace)
16
17	## My Plugin
18
19	Plugin name: [YOUR_PLUGIN_NAME]
20	Type: [frontend-only / full-stack]
21	Version: 1.0.0
22
23	Current plugin.json:
24	[PASTE YOUR plugin.json]
25
26	## Please Generate
27
28	1. Updated plugin.json — review and fix any issues, add missing fields
29
30	2. README.md — professional README with:
31	- Plugin description and screenshots section
32	- Features list
33	- Installation instructions
34	- Configuration options
35	- Usage guide
36	- API documentation (if full-stack)
37	- Contributing section
38	- License (MIT)
39
40	3. CHANGELOG.md — initial changelog:
41	```markdown
42	# Changelog
43
44	## [1.0.0] - [TODAY'S DATE]
45	### Added
46	- Initial release
47	- [LIST KEY FEATURES]

Pre-publish validation script — a shell script that:
- Runs linting
- Runs tests
- Builds frontend and backend
- Runs naap-plugin doctor
- Reports any issues
package.json scripts — ensure these scripts exist:
- build:umd (frontend)
- build (backend, if applicable)
- test
- lint
- doctor (runs naap-plugin doctor)
- prepublish (runs build + test + doctor)

1
2	## Prompt: Write Plugin Documentation
3
4	```markdown
5	# Task: Write Documentation for My NaaP Plugin
6
7	## Context
8
9	I want to publish documentation for my NaaP plugin so other users
10	know how to install, configure, and use it. NaaP supports plugin
11	documentation published to the community docs section.
12
13	## My Plugin
14
15	Plugin name: [YOUR_PLUGIN_NAME]
16	Description: [WHAT DOES YOUR PLUGIN DO]
17
18	Features:
19	[LIST ALL FEATURES — for example:
20	- Real-time task tracking with drag-and-drop Kanban board
21	- Team assignments and workload visualization
22	- Due date reminders and notifications
23	- CSV/JSON export
24	- Customizable columns and labels
25	]
26
27	Configuration options:
28	[LIST ANY SETTINGS — for example:
29	- Default view (Kanban / List / Table)
30	- Notification preferences
31	- Color theme for labels
32	]
33
34	API endpoints (if full-stack):
35	[LIST YOUR API ENDPOINTS]
36
37	## Generate
38
39	1. User-facing documentation (docs/README.md):
40	- Getting started guide
41	- Feature walkthrough with descriptions
42	- Configuration guide
43	- FAQ section
44	- Troubleshooting section
45
46	2. Developer documentation (docs/DEVELOPER.md):
47	- Architecture overview
48	- Local development setup
49	- API reference (if backend exists)
50	- Contributing guidelines
51	- Code style guide
52
53	3. MDX documentation page for the NaaP docs site (docs/plugin-doc.mdx):
54	- Frontmatter with title, description
55	- Overview section
56	- Installation section
57	- Usage guide with code examples
58	- Configuration reference
59	- Written in MDX format with proper headings
60
61	Write in a friendly, professional tone. Include code examples where helpful.

Prompt: Set Up CI/CD#

Markdown

1	# Task: Set Up CI/CD for My NaaP Plugin
2
3	## Context
4
5	I want to set up GitHub Actions to automatically test, build, and
6	optionally publish my NaaP plugin when I push to the repository.
7
8	## My Plugin
9
10	Plugin name: [YOUR_PLUGIN_NAME]
11	Type: [frontend-only / full-stack]
12	Repository: [github.com/YOUR_USERNAME/YOUR_REPO]
13
14	## Generate GitHub Actions Workflows
15
16	1. CI Workflow (.github/workflows/ci.yml):
17	- Triggers on: push to main, pull requests
18	- Steps:
19	- Checkout code
20	- Setup Node.js 20
21	- Install dependencies
22	- Run linting
23	- Run tests
24	- Build frontend (npm run build:umd)
25	- Build backend (if full-stack)
26	- Run naap-plugin doctor
27	- Report status as GitHub check
28
29	2. Publish Workflow (.github/workflows/publish.yml):
30	- Triggers on: GitHub Release created
31	- Steps:
32	- Run full CI checks
33	- Package plugin (naap-plugin package)
34	- Publish to NaaP marketplace (naap-plugin publish)
35	- Uses NAAP_AUTH_TOKEN secret for authentication
36
37	3. PR Preview Workflow (.github/workflows/preview.yml):
38	- Triggers on: pull request
39	- Runs tests and build
40	- Comments on PR with build status and size
41
42	Generate complete workflow YAML files.

Publishing Commands#

After the AI helps you prepare everything:

Terminal

# 1. Validate everything

$naap-plugin doctor

# 2. Build the plugin

$cd frontend && npm run build:umd

$cd ../backend && npm run build # if full-stack

# 3. Package it

$naap-plugin package

# Creates: [plugin-name]-1.0.0.naap-plugin

# 4. Log in to the marketplace

$naap-plugin login

# Follow the authentication flow

# 5. Publish!

$naap-plugin publish

# 6. Verify it's live

# Visit the marketplace in the NaaP shell

Prompt: Version and Update#

When you want to release a new version:

Markdown

1	# Task: Prepare a New Version of My NaaP Plugin
2
3	## Current Version: [e.g., 1.0.0]
4	## New Version: [e.g., 1.1.0]
5
6	## Changes Since Last Release
7
8	[DESCRIBE WHAT CHANGED — for example:
9	- Added dark mode support
10	- Fixed a bug where tasks wouldn't save
11	- Improved loading performance
12	- Added CSV export feature
13	]
14
15	## Please Generate
16
17	1. Updated version in plugin.json (and any package.json files)
18
19	2. CHANGELOG.md entry for the new version:
20	- Group changes by: Added, Changed, Fixed, Removed
21	- Follow Keep a Changelog format
22
23	3. Migration notes (if there are breaking changes):
24	- What changed
25	- How to update
26	- Any data migration needed
27
28	4. Updated README.md (if new features need documentation)
29
30	5. A git commit message and tag command:
31	```bash
32	git add .
33	git commit -m "release: v[NEW_VERSION]"
34	git tag v[NEW_VERSION]
35	git push && git push --tags