heyteam-cli 1.0.0

package/heyteam-instructions.md

@@ -0,0 +1,213 @@
+# HeyTeam Project Instructions
+
+This file contains all project configuration and instructions for AI agents (GitHub Copilot / Antigravity) to manage deployments using GitHub MCP server and Slack webhooks.
+
+---
+
+## 📋 Repository Configuration
+
+### Repositories
+
+| Repository | Owner | Name | Type |
+|------------|-------|------|------|
+| **UI (Frontend)** | `digicert` | `dtm` | User Interface |
+| **Backend** | `digicert` | `dtm-backend` | Backend API |
+
+---
+
+## 👥 Team Configuration
+
+> [!NOTE]
+> When creating PRs, the PR creator is automatically excluded from assignees and reviewers.
+
+### UI Team (Frontend Repository: digicert/dtm)
+| Role | Members |
+|------|---------|
+| **Assignees** | `@priti-kumari-dc`, `@surbhi-gupta-dc`, `@shiva-burade-dc` |
+| **Reviewers** | `@priti-kumari-dc`, `@surbhi-gupta-dc`, `@shiva-burade-dc` |
+
+### Backend Team (Backend Repository: digicert/dtm-backend)
+| Role | Members |
+|------|---------|
+| **Assignees** | `@jaydeep-raval-dc`, `@swaraj-dhumale-dc`, `@sharmajetesh`, `@shiva-burade-dc` |
+| **Reviewers** | `@jaydeep-raval-dc`, `@swaraj-dhumale-dc`, `@sharmajetesh`, `@shiva-burade-dc` |
+
+---
+
+## 🏷️ Labels Configuration
+
+### Backend Repository (dtm-backend)
+| Environment | Label |
+|-------------|-------|
+| Code (no deployment) | *No label* |
+| Development | `dev-deploy` |
+| Integration | `integration-deploy` |
+| Production | `prod-deploy` |
+
+### UI Repository (dtm)
+| Environment | Label |
+|-------------|-------|
+| Code (no deployment) | *No label* |
+| Development | `dev-deploy-user-interface` |
+| Integration | `integration-deploy-user-interface` |
+| Production | `integration-deploy-user-interface` |
+
+---
+
+## 🌿 Branch Strategy
+
+### Default Branch
+- Default target branch: `develop`
+
+### Deployment Branches (Backend: dtm-backend)
+
+| Current Branch Pattern | Target Branch | Label |
+|------------------------|---------------|-------|
+| `deployment/dev/**` | `deployment/dev/**-trigger` | `dev-deploy` |
+| `deployment/int/**` | `deployment/int/**-trigger` | `integration-deploy` |
+
+**Example:**
+- Branch `deployment/dev/feature-123` → PR to `deployment/dev/feature-123-trigger`
+- Branch `deployment/int/release-v1` → PR to `deployment/int/release-v1-trigger`
+
+### Deployment Branches (UI: dtm)
+
+| Current Branch Pattern | Target Branch | Label |
+|------------------------|---------------|-------|
+| `deployment/dev/**` | `deployment/dev/**-trigger` | `dev-deploy-user-interface` |
+| `deployment/int/**` | `deployment/int/**-trigger` | `integration-deploy-user-interface` |
+
+### Release Branches
+When asked to create PR against "latest release branch":
+1. Search for branches matching pattern `release/*`
+2. Use the most recently created branch
+3. Apply label: `integration-deploy` (backend) or `integration-deploy-user-interface` (UI)
+
+---
+
+## 🔔 Slack Notifications
+
+> [!NOTE]
+> The Slack webhook URL below will be populated during `heyteam init`. After initialization, this file (`heyteam-instructions.md`) will be added to `.gitignore` to prevent sensitive information from being committed to the repository.
+
+### Webhook URL
+```
+WEBHOOK_URL_PLACEHOLDER
+```
+_This will be replaced with your actual webhook URL during `heyteam init`._
+
+### Payload Structure
+```json
+{
+  "PR_LINK": "{PR_URL}"
+}
+```
+
+### Curl Command
+```bash
+curl -X POST -H 'Content-type: application/json' \
+  --data '{"PR_LINK": "PR_URL_HERE"}' \
+  'WEBHOOK_URL_PLACEHOLDER'
+```
+_The webhook URL above will be replaced with your actual URL during initialization._
+
+---
+
+## 🛠️ Required MCP Servers
+
+### Setup Instructions
+
+| IDE | How to Configure |
+|-----|-----------------|
+| **VSCode / VSCode Insiders** | Search `@mcp github` and `@mcp atlassian` in the chat panel |
+| **IntelliJ** | Add GitHub and Atlassian MCP server configurations to your MCP settings |
+
+### GitHub MCP Server Tools Reference
+
+#### Branch Operations
+- `list_branches` - List all branches (use to find latest release branch)
+- `create_branch` - Create a new branch from a reference
+- `get_branch` - Get details about a specific branch
+
+#### Pull Request Operations  
+- `create_pull_request` - Create a new pull request
+- `get_pull_request` - Get PR details
+- `list_pull_requests` - List PRs with filters
+- `update_pull_request` - Update PR title, body, or state
+
+#### Issue/PR Management
+- `add_issue_labels` - Add labels to an issue/PR
+- `assign_issue` - Assign users to an issue/PR
+- `request_pull_request_review` - Request reviewers for a PR
+
+### Atlassian (Jira) MCP Server Tools Reference
+
+- Used for adding comments to Jira tickets during deployments
+- Jira ticket ID is extracted from branch names (pattern: `DTM-XXXX`)
+
+---
+
+## 🎫 Jira Integration
+
+### Ticket ID Extraction
+- Branch name pattern: `feature/DTM-2494-some-description` → Jira ticket `DTM-2494`
+- Only the `DTM-` prefix is supported
+
+### Comment Behavior
+- A meaningful comment is added to the Jira ticket on every ship workflow
+- Comment includes: summary of changes, PR URL (if applicable), and target environment
+- If no Jira ticket ID is found in the branch name, this step is skipped
+
+---
+
+## 📝 Workflow Commands
+
+### ship-code
+Create a PR for code review only (no deployment labels).
+- Target: `develop` branch (or specified branch)
+- Labels: None
+- Assignees/Reviewers: Based on repository
+
+### ship-dev
+Create a PR for development deployment.
+- **Backend (dtm-backend)**:
+  - If branch is `deployment/dev/**` → target `deployment/dev/**-trigger`
+  - Otherwise → target `develop`
+  - Label: `dev-deploy`
+- **UI (dtm)**:
+  - If branch is `deployment/dev/**` → target `deployment/dev/**-trigger`
+  - Otherwise → target `develop`
+  - Label: `dev-deploy-user-interface`
+
+### ship-int
+Create a PR for integration deployment.
+- **Backend (dtm-backend)**:
+  - If branch is `deployment/int/**` → target `deployment/int/**-trigger`
+  - Otherwise → target latest `release/*` branch or `develop`
+  - Label: `integration-deploy`
+- **UI (dtm)**:
+  - If branch is `deployment/int/**` → target `deployment/int/**-trigger`
+  - Otherwise → target latest `release/*` branch or `develop`
+  - Label: `integration-deploy-user-interface`
+
+### ship-prod
+Create a PR for production deployment.
+- **Backend**: Label `prod-deploy`
+- **UI**: Label `integration-deploy-user-interface`
+- Requires multiple approvals
+
+---
+
+## 📖 Usage Examples
+
+### Ship code (no deployment)
+> "Create a PR from my current branch to develop for code review"
+
+### Ship to dev
+> "Ship my current branch to dev environment"
+
+### Ship to int with latest release
+> "Create PR against the latest release branch for integration deployment"
+
+### Ship to prod
+> "Create production PR from integration"

package/package.json

@@ -0,0 +1,30 @@
+{
+    "name": "heyteam-cli",
+    "version": "1.0.0",
+    "description": "CLI for setting up HeyTeam AI agents",
+    "main": "dist/index.js",
+    "bin": {
+        "heyteam-cli": "./dist/index.js"
+    },
+    "scripts": {
+        "build": "tsc",
+        "start": "node dist/index.js",
+        "dev": "ts-node src/index.ts"
+    },
+    "keywords": [],
+    "author": "",
+    "license": "ISC",
+    "dependencies": {
+        "chalk": "^4.1.2",
+        "commander": "^11.1.0",
+        "fs-extra": "^11.2.0",
+        "inquirer": "^8.2.5"
+    },
+    "devDependencies": {
+        "@types/fs-extra": "^11.0.4",
+        "@types/inquirer": "^9.0.7",
+        "@types/node": "^20.11.5",
+        "ts-node": "^10.9.2",
+        "typescript": "^5.3.3"
+    }
+}