Skip to content

Commit e6c9bee

Browse files
committed
ICU-23055 Update docs for BRS commit checker instructions
1 parent 464e418 commit e6c9bee

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

docs/processes/release/tasks/miscellaneous.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,11 +80,29 @@ by:
8080
The dropdown should reveal an input form in which to provide inputs
8181

8282
1. Provide the same inputs in the form as you would for a local run of the tool,
83-
as described in the tool's Readme in the instructions above.
83+
as described in the [tool's Readme](https://github.com/unicode-org/icu/tree/main/tools/commit-checker) in the instructions above.
8484

8585
The only difference from the local run instructions is that git branch names in the
86-
Actions workflow input form should be prefixed with `origin/`.
87-
86+
Actions workflow input form should be prefixed with `origin/`. Ex:
87+
88+
```
89+
The ICU Jira "Fix Version" semver -> 78.1
90+
The git ref start of comparison range. Prefix branches with `origin/`. -> release-77-1
91+
The git ref end of comparison range. Must be descendant of `from_git_ref`. Prefix branches with `origin/`. -> origin/main
92+
```
93+
94+
1. If the job fails with an error such as this:
95+
96+
```
97+
jira.exceptions.JIRAError: JiraError HTTP 404 url: https://unicode-org.atlassian.net/rest/api/2/issue/ICU-XXXXX
98+
text: Issue does not exist or you do not have permission to see it.
99+
```
100+
101+
then you likely can solve this by recreating the Jira API token as described in the [tool's Readme](https://github.com/unicode-org/icu/tree/main/tools/commit-checker) in the instructions above.
102+
Since 2024, the [Jira API tokens are not allowed to last longer than 365 days](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/),
103+
but may expire more quickly than 365 days depending on what duration was set, etc.
104+
The account corresponding to the email should be allowed to view sensitive tickets, or else any
105+
existence of sensitive tickets in the git commit range will cause a failure.
88106
---
89107
90108
## Fix Mis-ticketted commits

0 commit comments

Comments
 (0)