Skip to content

Commit 9c564c7

Browse files
committed
Update CCB ticket creation instructions with ADF format requirements
Add detailed instructions for creating CCB tickets via Atlassian MCP tools, including the required Atlassian Document Format (ADF) for textarea fields. - Document all required custom fields and their IDs - Provide ADF format examples for text and bullet lists - Explain common error and solution for textarea fields - Update linking instructions to use addCommentToJiraIssue
1 parent ba6e1ac commit 9c564c7

File tree

1 file changed

+85
-17
lines changed

1 file changed

+85
-17
lines changed

docs/steps-to-create-new-terminus-release.md

Lines changed: 85 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -31,23 +31,91 @@ If any of these steps should fail, abort the release-cutting process.
3131
3. This PR can be merged after CCB approval.
3232

3333
6. Draft a Jira ticket in "CCB" project to get approval from the "Change Control Board":
34-
1. **Create CCB Change Request** using Atlassian MCP tools (preferred) or web interface:
35-
- **Project:** CCB
36-
- **Issue Type:** CCB Change Request
37-
- **Squad:** Developer Experience (11058)
38-
- **Service/Component:** terminus
39-
- **Summary:** Terminus X.Y.Z Release
40-
- **Business Justification:** Describe customer benefits
41-
- **Testing:** Reference GitHub Actions + manual testing against production
42-
- **Rollback Plan:** Emergency hotfix release to previous version
43-
- **Code Review Link:** GitHub PR URL
44-
- **Risk Assessment:** Typically low risk for additive features
45-
- **Monitoring Plans:** User feedback in Slack/support tickets.
46-
- **Feature Flag:** None (client-side tool)
47-
- **Urgency:** Normal
48-
- **Tested in Sandbox:** No
49-
2. **Link to related tickets:** Include a link to the original DEVX ticket.
50-
3. **Leave in Draft status** until ready for CCB review. Ready for CCB review after release PR is _approved_.
34+
1. **Create CCB Change Request** using Atlassian MCP tools with the following approach:
35+
36+
**Important:** CCB textarea fields require Atlassian Document Format (ADF), which is a JSON structure. Plain text will be rejected with "Operation value must be an Atlassian Document Format" error.
37+
38+
Use `mcp__atlassian__createJiraIssue` with these parameters:
39+
- **cloudId:** `12519b81-57b5-457a-bee5-0534438e646b`
40+
- **projectKey:** `CCB`
41+
- **issueTypeName:** `CCB Change Request`
42+
- **summary:** `Terminus X.Y.Z Release`
43+
- **description:** Markdown description of the release
44+
- **additional_fields:** JSON object with these fields:
45+
- `customfield_12050`: Squad - `{"id": "11058"}` (Developer Experience)
46+
- `customfield_13303`: Urgency - `{"id": "12071"}` (Normal)
47+
- `customfield_13304`: Service/Component - `"terminus"` (plain string)
48+
- `customfield_13313`: Feature Flag - ADF format (see example below)
49+
- `customfield_13314`: Business Justification - ADF format
50+
- `customfield_13315`: Risk of NOT deploying - ADF format
51+
- `customfield_13319`: Customer Impact Monitoring - ADF format
52+
- `customfield_13320`: Pantheon Internal Monitoring - ADF format
53+
- `customfield_13322`: Testing and Validation - ADF format
54+
- `customfield_13323`: Testing Signoff - `{"accountId": "712020:949f07e7-2e08-4b5a-a6f9-072413aa303d"}`
55+
- `customfield_13324`: Roll back plan - ADF format
56+
- `customfield_13325`: Code Review Links - ADF format
57+
- `customfield_13418`: Tested in Sandbox - `{"id": "12263"}` (No)
58+
- `customfield_13413`: Is this change risky - `{"id": "12261"}` (No)
59+
- `customfield_13479`: Customer site downtime - `{"id": "12395"}` (No)
60+
61+
**ADF Format Example** (for text fields):
62+
```json
63+
{
64+
"version": 1,
65+
"type": "doc",
66+
"content": [
67+
{
68+
"type": "paragraph",
69+
"content": [
70+
{
71+
"type": "text",
72+
"text": "Your text here"
73+
}
74+
]
75+
}
76+
]
77+
}
78+
```
79+
80+
For bullet lists in ADF:
81+
```json
82+
{
83+
"version": 1,
84+
"type": "doc",
85+
"content": [
86+
{
87+
"type": "paragraph",
88+
"content": [{"type": "text", "text": "Introduction text"}]
89+
},
90+
{
91+
"type": "bulletList",
92+
"content": [
93+
{
94+
"type": "listItem",
95+
"content": [
96+
{
97+
"type": "paragraph",
98+
"content": [{"type": "text", "text": "First item"}]
99+
}
100+
]
101+
},
102+
{
103+
"type": "listItem",
104+
"content": [
105+
{
106+
"type": "paragraph",
107+
"content": [{"type": "text", "text": "Second item"}]
108+
}
109+
]
110+
}
111+
]
112+
}
113+
]
114+
}
115+
```
116+
117+
2. **Link to related tickets:** Add a comment to both CCB ticket and DEVX ticket using `mcp__atlassian__addCommentToJiraIssue` to cross-reference them.
118+
3. **Leave in Draft status** until ready for CCB review. Ready for CCB review after release PR is _approved_.
51119
4. **Manual creation URL (if needed):** [https://getpantheon.atlassian.net/secure/CreateIssue.jspa?issuetype=ccb-change-request&pid=14450](https://getpantheon.atlassian.net/secure/CreateIssue.jspa?issuetype=ccb-change-request&pid=14450)
52120
5. Proceed to next step, which can be prepared in advance of approvals.
53121

0 commit comments

Comments
 (0)