Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

expand checklists of issue links in description #29

Merged
merged 1 commit into from
Jul 12, 2024

Conversation

grokspawn
Copy link
Collaborator

There's a clever way to handle epics in github where you can create a checklist of sub-issue titles, and then auto-generate an issue from each one (for example operator-framework/catalogd#239). The challenge is that this results in a changed format that has no context or value when transplanted to jira.

The resulting description looks something like:

- [ ] #304 [doc](https://docs.google.com/document/d/1kIVQUM0M-GwZrfEuc9CJPHnNClh1sMaDK-XRIZgj1Rs/)
- [ ] #305
- [ ] #306
- [ ] #307
- [ ] #308
- [ ] #309 

with this change the issue links are preserved as jira links anchored by the conventional abbreviation format (i.e https://www.github.com/domain/project/issue/123 is abbreviated to domain/project#123.

Here is an example expanded description (which of course won't display appropriately here)

 * [operator-framework/catalogd#304|https://github.com/operator-framework/catalogd/issues/304] [doc](https://docs.google.com/document/d/1kIVQUM0M-GwZrfEuc9CJPHnNClh1sMaDK-XRIZgj1Rs/)
 * [operator-framework/catalogd#305|https://github.com/operator-framework/catalogd/issues/305]
 * [operator-framework/catalogd#306|https://github.com/operator-framework/catalogd/issues/306]
 * [operator-framework/catalogd#307|https://github.com/operator-framework/catalogd/issues/307]
 * [operator-framework/catalogd#308|https://github.com/operator-framework/catalogd/issues/308]
 * [operator-framework/catalogd#309|https://github.com/operator-framework/catalogd/issues/309]

Please note that this effort does not attempt to be a general-purpose markdown-to-jira reformatter.

@grokspawn grokspawn requested a review from oceanc80 as a code owner July 12, 2024 16:50
@coveralls
Copy link

Pull Request Test Coverage Report for Build 9911342029

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 67.954%

Totals Coverage Status
Change from base Build 9162502314: 0.0%
Covered Lines: 176
Relevant Lines: 259

💛 - Coveralls

@oceanc80 oceanc80 merged commit 89214bb into oceanc80:main Jul 12, 2024
2 checks passed
@grokspawn grokspawn deleted the link-expander branch July 12, 2024 20:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants