Skip to content

Commit

Permalink
Merge pull request 2i2c-org#4621 from GeorgianaElena/update-dod
Browse files Browse the repository at this point in the history
Update issue templates to provide a definition of done section
  • Loading branch information
GeorgianaElena authored Aug 14, 2024
2 parents c8d80c7 + c54771a commit 14851a8
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 16 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,15 @@ body:
The Definition of Done. What must be true to consider this task complete?
validations:
required: true

- type: checkboxes
attributes:
label: Pre-defined Definition of Done
description: A non-specific, pre-defined list of tasks that should be considered before marking the task complete.
options:
- label: All the tasks have been completed
required: false
- label: It has been tested to work and to not break any existing functionality
required: false
- label: Documentation was added so other engineers can implement this in the future if needed
required: false
9 changes: 7 additions & 2 deletions .github/ISSUE_TEMPLATE/05_decommission-hub.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: "\U0001F4E6 Decommission a Hub"
about: Decommission a Hub that is no longer in active use
title: "[Decommission Hub] {{ HUB NAME }}"
title: "[Decommission Hub][{{ deadline }}] {{ HUB NAME }}"
labels: ''
assignees: ''

Expand Down Expand Up @@ -38,9 +38,9 @@ Usually, it is because it was a hub that we created for a workshop/conference an
- [ ] Remove the appropriate `config/clusters/<cluster_name>/<hub_name>.values.yaml` files. A complete list of relevant files can be found under the appropriate entry in the associated `cluster.yaml` file.
- [ ] Remove the associated hub entry from the `config/clusters/<cluster_name>/cluster.yaml` file.
- [ ] Remove the hub deployment
- TIP: Run `deployer use-cluster-credentials <cluster_name>` before running the commands below
- `helm --namespace HUB_NAME delete HUB_NAME`
- `kubectl delete namespace HUB_NAME`
- TIP: Run `deployer use-cluster-credentials <cluster_name>` before running the above commands

#### Phase III - Cluster Removal

Expand All @@ -56,3 +56,8 @@ _This phase is only necessary for single hub clusters._
- [ ] [`deploy-hubs.yaml`](https://github.com/2i2c-org/infrastructure/blob/HEAD/.github/workflows/deploy-hubs.yaml)
- [ ] [`deploy-grafana-dashboards.yaml`](https://github.com/2i2c-org/infrastructure/blob/HEAD/.github/workflows/deploy-grafana-dashboards.yaml)
- [ ] Remove A record from Namecheap account

### Definition of Done
_A non-specific, pre-defined list of tasks that should be considered before marking the task complete._
- [] All the tasks above have been completed
- [] Existing functionality was not broken
37 changes: 23 additions & 14 deletions .github/ISSUE_TEMPLATE/06_event-hub.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: 📅 Event for a community
description: Coordination and planning around an event for a community
title: "[EVENT] {{ HUB NAME }}"
title: "[EVENT][{{ dates }}] {{ HUB NAME }}"
labels: ["event"]
body:
- type: markdown
Expand All @@ -27,7 +27,7 @@ body:
description: |
Type the GitHub handle of the community representative or their name if the handle is not known.
validations:
required: true
required: false

- type: textarea
id: event_begin
Expand Down Expand Up @@ -117,18 +117,27 @@ body:
General checks to perform before the event.
- type: checkboxes
id: info_available
- type: textarea
id: tasks
attributes:
label: Was all the info filled in above?
options:
- label: "Yes"
- label: "No"
label: Task list
description: |
(optional) A clear and concise list of steps to take to close this issue.
value: |
- [ ] Was all the info filled in above?
- [ ] Quotas from the cloud provider are high-enough to handle expected usage?
- [ ]
validations:
required: true

- type: checkboxes
id: quotas_ok
- type: textarea
id: dod
attributes:
label: Quotas from the cloud provider are high-enough to handle expected usage?
options:
- label: "Yes"
- label: "No"
label: Definition of Done
description: |
The Definition of Done. What must be true to consider this task complete?
value: |
- [ ] All the tasks have been completed
- [ ]
validations:
required: true

0 comments on commit 14851a8

Please sign in to comment.