Skip to content

docs(flaky-tests): note that Jira labels cannot contain spaces#591

Draft
samgutentag wants to merge 1 commit intomainfrom
sam-gutentag/jira-labels-no-spaces
Draft

docs(flaky-tests): note that Jira labels cannot contain spaces#591
samgutentag wants to merge 1 commit intomainfrom
sam-gutentag/jira-labels-no-spaces

Conversation

@samgutentag
Copy link
Copy Markdown
Member

Summary

  • Documents the Jira API restriction that labels cannot contain spaces
  • The Trunk UI now enforces this restriction in the labels field (no spaces accepted)

Source

Test plan

  • Preview in GitBook

Generated by Claude Code

Jira's API rejects labels with spaces. The Trunk UI now enforces this
by preventing spaces in the labels field (trunk2 PR #3794).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@trunk-staging-io
Copy link
Copy Markdown

Merging to main in this repository is managed by Trunk.

  • To merge this pull request, check the box to the left or comment /trunk merge below.

After your PR is submitted to the merge queue, this comment will be automatically updated with its status. If the PR fails, failure details will also be posted here

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Apr 30, 2026

Claude finished @samgutentag's task in 1m 9s —— View job


Review complete

  • Gather context
  • Read changed file and diff
  • Review for typos, grammar, formatting, and documentation best practices
  • Post findings

The change looks good. A {% hint style="info" %} block is placed correctly right after the configuration table where labels are described, which is exactly the right location for this callout.

Observations:

  • No typos or grammatical errors.
  • Hint style (info) is consistent with the analogous hint below (line 69–71 in the file) that documents the 365-day token expiry.
  • The em dash usage is correct.
  • One minor suggestion posted inline: the second sentence partially restates the first — the note could be tightened slightly. Not blocking.

The example in the table (flaky-test, debt) is fine — both label values themselves are space-free, and the comma is just a visual separator in the table cell.

Result: ✅ No blocking issues.

<table data-full-width="false"><thead><tr><th width="176">Field Name</th><th width="266">Description</th><th>Examples</th></tr></thead><tbody><tr><td>Jira URL</td><td>The URL to your Jira Cloud project.</td><td><code>https://trunk-io.atlassian.net</code></td></tr><tr><td>Project Key</td><td>The project key for your Jira project.</td><td><code>KAN</code></td></tr><tr><td>Email</td><td>The email associated with your Jira API token.</td><td><code>johndoe@example.com</code></td></tr><tr><td><a href="jira-integration.md#api-token-permissions">Jira API token</a></td><td><a href="https://id.atlassian.com/manage-profile/security/api-tokens">Create your Jira API token here.</a></td><td><code>ATATT*****19FNY5Q</code></td></tr><tr><td>Default label(s) for new tickets</td><td>Labels applied to new Jira tickets created through Trunk Flaky Tests</td><td><code>flaky-test, debt</code></td></tr></tbody></table>

{% hint style="info" %}
Jira labels cannot contain spaces. The Trunk UI enforces this restriction — spaces are not accepted in the labels field when configuring your integration or creating tickets.
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.

The second clause ("spaces are not accepted in the labels field when configuring your integration or creating tickets") mostly restates the first sentence. Consider tightening to avoid redundancy:

Suggested change
Jira labels cannot contain spaces. The Trunk UI enforces this restriction — spaces are not accepted in the labels field when configuring your integration or creating tickets.
Jira labels cannot contain spaces — the Trunk UI enforces this restriction in the labels field.

Minor style suggestion, not blocking.

Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

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

Auto-approved: Claude code review passed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants