jira-collaboration

📁 grandcamel/jira-assistant-skills 📅 13 days ago
1
总安装量
1
周安装量
#52567
全站排名
安装命令
npx skills add https://github.com/grandcamel/jira-assistant-skills --skill jira-collaboration

Skill 文档

jira-collaborate

Collaboration features for JIRA issues – comments, attachments, watchers, and notifications.

Risk Levels

Operation Risk Notes
List comments/attachments - Read-only
List watchers - Read-only
View activity history - Read-only
Add comment - Easily reversible (can delete)
Upload attachment - Easily reversible (can delete)
Add watcher - Can remove watcher
Send notification - Cannot unsend but harmless
Update comment ! Previous text lost
Update custom fields ! Can be undone via edit
Remove watcher ! Can re-add
Delete comment !! Comment text lost
Delete attachment !! File lost, must re-upload

Risk Legend: - Safe, read-only | ! Caution, modifiable | !! Warning, destructive but recoverable | !!! Danger, irreversible

When to use this skill

Use this skill when you need to:

  • Add, update, or delete comments on issues
  • Upload or download attachments
  • Manage watchers (add/remove)
  • Send notifications to users or groups
  • View issue activity and changelog

What this skill does

IMPORTANT: Always use the jira-as CLI. Never run Python scripts directly.

  1. Comments: Add/edit/delete comments with rich text support
  2. Attachments: Upload and download files
  3. Watchers: Manage who tracks the issue
  4. Notifications: Send targeted notifications
  5. Activity History: View issue changelog
  6. Custom Fields: Update custom field values

Available Commands

Comments

Command Description
jira-as collaborate comment add Add comment with visibility controls
jira-as collaborate comment update Update existing comment
jira-as collaborate comment delete Delete comment (with confirmation)
jira-as collaborate comment list List and search comments

Attachments

Command Description
jira-as collaborate attachment upload Upload file to issue
jira-as collaborate attachment download Download or list attachments

Notifications & Activity

Command Description
jira-as collaborate notify Send notifications to users/groups
jira-as collaborate activity View issue changelog

Watchers & Fields

Command Description
jira-as collaborate watchers Add/remove/list watchers
jira-as collaborate update-fields Update custom fields

All commands support --help for full documentation.

Quick Start Examples

# Add a comment
jira-as collaborate comment add PROJ-123 --body "Starting work on this now"

# Rich text comment
jira-as collaborate comment add PROJ-123 --body "**Bold** text" --format markdown

# Internal comment (role-restricted)
jira-as collaborate comment add PROJ-123 --body "Internal note" --visibility-role Administrators

# List comments
jira-as collaborate comment list PROJ-123
jira-as collaborate comment list PROJ-123 --limit 10 --order asc

# Update a comment (requires comment ID)
jira-as collaborate comment update PROJ-123 --id 10001 --body "Updated text"

# Delete a comment
jira-as collaborate comment delete PROJ-123 --id 10001 --yes

# Upload attachment
jira-as collaborate attachment upload PROJ-123 --file screenshot.png

# Download attachment (use attachment ID from issue details)
jira-as collaborate attachment download PROJ-123 12345 --output ./downloads/

# List watchers
jira-as collaborate watchers PROJ-123 --list

# Add watcher
jira-as collaborate watchers PROJ-123 --add user@example.com

# Remove watcher
jira-as collaborate watchers PROJ-123 --remove user@example.com

# Send notification to watchers
jira-as collaborate notify PROJ-123 --watchers --subject "Update" --body "Issue resolved"

# Send notification to specific users (use account IDs)
jira-as collaborate notify PROJ-123 --user 5b10a2844c20165700ede21g --subject "Review needed"

# Send notification to assignee and reporter
jira-as collaborate notify PROJ-123 --assignee --reporter --subject "Please review"

# Preview notification without sending
jira-as collaborate notify PROJ-123 --watchers --dry-run

# View activity history
jira-as collaborate activity PROJ-123

# View activity with filters
jira-as collaborate activity PROJ-123 --field status --field assignee --output table
jira-as collaborate activity PROJ-123 --field-type custom --limit 10

Common Options

All commands support:

Option Description
--help, -h Show detailed help

For command-specific options, use --help on any command:

jira-as collaborate comment add --help
jira-as collaborate notify --help

See references/SCRIPT_OPTIONS.md for full option matrix.

Exit Codes

Code Description
0 Success
1 General error (validation, API error, network issue)

Troubleshooting

Error Solution
“Comment not found” Verify comment ID with jira-as collaborate comment list ISSUE-KEY
“Attachment not found” Use --list to see available attachments
“Permission denied” Check visibility role/group permissions
“User not found” Use account ID (not email) for watchers
“Notification not received” Use --dry-run to verify recipients

For debug mode: export JIRA_DEBUG=1

Documentation Structure

Getting Started: docs/GETTING_STARTED.md – First 5 minutes

Common Scenarios: docs/scenarios/ – Workflow examples

Reference: docs/QUICK_REFERENCE.md – Commands and JQL

Templates: docs/TEMPLATES.md – Copy-paste ready

Advanced Topics: docs/DEEP_DIVES/ – Deep dive guides

Format Reference: references/adf_guide.md – Markdown to ADF

Related Skills

  • jira-issue: For creating and updating issue fields
  • jira-lifecycle: For transitioning with comments
  • jira-search: For finding issues to collaborate on