From 71967b0ca77b809934b596efa8027729a3ce541c Mon Sep 17 00:00:00 2001 From: Jack Rubacha Date: Sun, 19 Jan 2025 23:49:07 -0500 Subject: [PATCH] add support for gh projects, standardize workflows (#17) --- .github/ISSUE_TEMPLATE/bug-form.yml | 19 +------ .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/epic.yml | 64 ---------------------- .github/ISSUE_TEMPLATE/feature-request.yml | 26 --------- .github/ISSUE_TEMPLATE/other.yml | 18 ------ .github/ISSUE_TEMPLATE/spike.yml | 38 ------------- .github/ISSUE_TEMPLATE/task.yml | 9 +-- .github/pull_request_template.md | 1 - .github/workflows/build-check.yml | 6 +- 9 files changed, 11 insertions(+), 172 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/epic.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/other.yml delete mode 100644 .github/ISSUE_TEMPLATE/spike.yml diff --git a/.github/ISSUE_TEMPLATE/bug-form.yml b/.github/ISSUE_TEMPLATE/bug-form.yml index f3df30d..854803d 100644 --- a/.github/ISSUE_TEMPLATE/bug-form.yml +++ b/.github/ISSUE_TEMPLATE/bug-form.yml @@ -2,33 +2,20 @@ name: Bug description: For any issue related to a bug title: '[Area] - Short Description' labels: [bug] +projects: ["Northeastern-Electric-Racing/20"] body: - type: textarea id: observed-behavior attributes: label: Observed Behavior - description: What happened? - validations: - required: true - - type: textarea - id: expected-behavior - attributes: - label: Expected Behavior - description: What should have happened? + description: What happened? What should of happened? validations: required: true - type: textarea id: steps-to-reproduce attributes: label: Steps to Reproduce - description: How could someone reproduce this bug? + description: How could someone reproduce this bug? Include versions of code or PCBs as applicable. value: "1. \n2. \n3. " validations: required: true - - type: textarea - id: screenshots - attributes: - label: Screenshots (as needed) - description: Add screenshots of the bug if applicable - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 0086358..3ba13e0 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1 +1 @@ -blank_issues_enabled: true +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/epic.yml b/.github/ISSUE_TEMPLATE/epic.yml deleted file mode 100644 index 1827d9e..0000000 --- a/.github/ISSUE_TEMPLATE/epic.yml +++ /dev/null @@ -1,64 +0,0 @@ -name: Epic -description: A collection of many tasks -title: '[Area] - Short Description' -labels: [epic] -body: - - type: textarea - id: overview - attributes: - label: Overview - description: Provide a brief summary of this epic - validations: - required: true - - type: textarea - id: stakeholders - attributes: - label: Stakeholders - description: Who to contact for this epic? - value: | - Product Stakeholder: - Software Stakeholder: - Reference Users: - - type: textarea - id: metrics - attributes: - label: Success Metrics - description: What are the metrics we will use to determine if this is successful? - validations: - required: true - - type: textarea - id: rollout - attributes: - label: Rollout Plan - description: How will this be released? All at once? In parts? - validations: - required: true - - type: textarea - id: scope - attributes: - label: Out of Scope - description: What is not included in this epic? - validations: - required: true - - type: textarea - id: background-context - attributes: - label: Background / Context - description: What is the context for this epic? What already exists? - validations: - required: true - - type: textarea - id: acceptance - attributes: - label: Acceptance Criteria - description: How are we evaluating the success of this epic? - validations: - required: true - - type: textarea - id: tickets - attributes: - label: Tickets - description: What tickets will be a part of this epic? - value: " - [ ] #\n - [ ] #" - validations: - required: true diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml deleted file mode 100644 index 4b491b0..0000000 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ /dev/null @@ -1,26 +0,0 @@ -name: Feature Request -description: Suggest a new feature for the project -title: '[Area] - Short Description' -labels: [new feature] -body: - - type: textarea - id: current-features - attributes: - label: Current Features - description: What exists currently? - validations: - required: true - - type: textarea - id: desired-features - attributes: - label: Desired Additional Features - description: What features do you want to add? - validations: - required: true - - type: textarea - id: screenshots - attributes: - label: Screenshots (as needed) - description: Add screenshots of the current or desired state if applicable - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/other.yml b/.github/ISSUE_TEMPLATE/other.yml deleted file mode 100644 index 7df8945..0000000 --- a/.github/ISSUE_TEMPLATE/other.yml +++ /dev/null @@ -1,18 +0,0 @@ -name: Other -description: For issues that don't fit the other categories -title: '[Area] - Short Description' -body: - - type: textarea - id: desired-changes - attributes: - label: Desired Changes - description: What changes do you want to make? - validations: - required: true - - type: textarea - id: screenshots - attributes: - label: Screenshots (as needed) - description: Add screenshots if applicable - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/spike.yml b/.github/ISSUE_TEMPLATE/spike.yml deleted file mode 100644 index f5dc1c4..0000000 --- a/.github/ISSUE_TEMPLATE/spike.yml +++ /dev/null @@ -1,38 +0,0 @@ -name: Spike -description: For any research or investigation into a feature or our current architecture -title: '[Area] - Short Description' -labels: [spike] -body: - - type: markdown - attributes: - value: For a spike ticket, please make sure to remember to add links to the resources you are pulling information from so others who are reviewing and giving feedback can also take a look at the same information you are looking at. - - type: dropdown - id: spike-type - attributes: - label: Spike Type - description: Is this spike about the product (functional) or the implementation of the product (technical)? - multiple: true - options: - - Functional - - Technical - - type: textarea - id: goal - attributes: - label: Goal - description: What is this spike ticket looking into/trying to solve? Is this about enhancing something we currently do or looking into a new feature? - validations: - required: true - - type: textarea - id: purpose - attributes: - label: Reason for Spike - description: Why is this spike ticket necessary? - validations: - required: true - - type: textarea - id: sidenotes - attributes: - label: Additional notes - description: Add any extra comments related to the spike. - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/task.yml b/.github/ISSUE_TEMPLATE/task.yml index 81bd791..0328d7d 100644 --- a/.github/ISSUE_TEMPLATE/task.yml +++ b/.github/ISSUE_TEMPLATE/task.yml @@ -1,19 +1,20 @@ -name: Task -description: Create a task that a developer can complete. +name: Feature +description: Describe a feature that a developer can add. title: '[Area] - Short Description' +projects: ["Northeastern-Electric-Racing/20"] body: - type: textarea id: description attributes: label: Description - description: Provide a brief summary of this issue + description: Provide a brief summary of the current shortcoming or new improvement validations: required: true - type: textarea id: acceptance-criteria attributes: label: Acceptance Criteria - description: What are the conditions that need to be satisified to complete this task? + description: What are the test conditions that need to be satisified to complete this task? validations: required: true - type: textarea diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 5c723e3..0a8fc14 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -25,7 +25,6 @@ It can be helpful to check the `Checks` and `Files changed` tabs. Please reach out to your Project Lead if anything is unclear. Please request reviewers and ping on slack only after you've gone through this whole checklist. -- [ ] All commits are tagged with the ticket number - [ ] No merge conflicts - [ ] All checks passing - [ ] Remove any non-applicable sections of this template diff --git a/.github/workflows/build-check.yml b/.github/workflows/build-check.yml index 5ee76bb..4ee223c 100644 --- a/.github/workflows/build-check.yml +++ b/.github/workflows/build-check.yml @@ -3,8 +3,6 @@ on: [push] jobs: run-build: runs-on: ubuntu-latest - container: - image: ghcr.io/northeastern-electric-racing/embedded-base:main timeout-minutes: 10 steps: - name: Checkout code @@ -14,7 +12,7 @@ jobs: - name: Execute Make run: | - if ! make; then + if ! docker compose run --rm ner-gcc-arm make -j `nproc`; then echo "The application has failed to build." exit 1 # This will cause the workflow to fail - fi \ No newline at end of file + fi