Skip to content

Commit

Permalink
Update GH files for issue templates and Jira automation (#29)
Browse files Browse the repository at this point in the history
* Update GH files for issue templates and Jira automation

This PR updates the .github files to
* Ensure we have a file for tasks/enhancements
* Ensure we expose dod in task issues
* Use the FastAPI for ticket sync, and not JIRA_URL

* review: Update task template
  • Loading branch information
kimwnasptd committed Dec 11, 2023
1 parent e7adff1 commit 7729ae6
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 20 deletions.
31 changes: 31 additions & 0 deletions .github/.jira_sync_config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
settings:
# Jira project key to create the issue in
jira_project_key: "KF"

# Dictionary mapping GitHub issue status to Jira issue status
status_mapping:
opened: Untriaged
closed: done

# (Optional) GitHub labels. Only issues with one of those labels will be synchronized.
# If not specified, all issues will be synchronized
labels:
- bug
- enhancement

# (Optional) (Default: false) Add a new comment in GitHub with a link to Jira created issue
add_gh_comment: true

# (Optional) (Default: true) Synchronize issue description from GitHub to Jira
sync_description: true

# (Optional) (Default: true) Synchronize comments from GitHub to Jira
sync_comments: false

# (Optional) (Default: None) Parent Epic key to link the issue to
epic_key: "KF-4805"

# (Optional) Dictionary mapping GitHub issue labels to Jira issue types.
# If label on the issue is not in specified list, this issue will be created as a Bug
label_mapping:
enhancement: Story
23 changes: 20 additions & 3 deletions .github/ISSUE_TEMPLATE/task.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,36 @@ body:
proposal! Before submitting your issue, please make sure there
isn't already a prior issue concerning this. If there is,
please join that discussion instead.
- type: textarea
id: enhancement-proposal-context
attributes:
label: Context
description: >
Describe why we should work on this task/enhancement, as well as
existing context we should be aware of
validations:
required: true
- type: textarea
id: enhancement-proposal-what
attributes:
label: What needs to get done
description: >
Describe what needs to get done
placeholder: |
1. Look into X
2. Implement Y
3. Create file Z
validations:
required: true
- type: textarea
id: enhancement-proposal-why
id: enhancement-proposal-dod
attributes:
label: Why it needs to get done
label: Definition of Done
description: >
Describe why it needs to get done
What are the requirements for the task to be considered done
placeholder: |
1. We know how X works (spike)
2. Code is doing Y
3. Charm has functionality Z
validations:
required: true
17 changes: 0 additions & 17 deletions .github/workflows/issues_to_jira.yaml

This file was deleted.

0 comments on commit 7729ae6

Please sign in to comment.