Skip to content

Commit

Permalink
Merge branch 'Develop' into protobuf-v2
Browse files Browse the repository at this point in the history
  • Loading branch information
jr1221 authored Oct 25, 2024
2 parents 18da33d + 88d02e0 commit 94ce9ea
Show file tree
Hide file tree
Showing 21 changed files with 750 additions and 60 deletions.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-form.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Bug
description: For any issue related to a bug
title: '[Area] - Short Description'
labels: [bug]
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?
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to Reproduce
description: How could someone reproduce this bug?
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
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/epic.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
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
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
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
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/other.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
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
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/spike.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
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
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/task.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Task
description: Create a task that a developer can complete.
title: '[Area] - Short Description'
body:
- type: textarea
id: description
attributes:
label: Description
description: Provide a brief summary of this issue
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?
validations:
required: true
- type: textarea
id: proposed-solution
attributes:
label: Proposed Solution
description: How will this solution be implemented? What will be changed or added?
validations:
required: true
35 changes: 35 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## Changes

_Explanation of changes goes here_

## Notes

_Any other notes go here_

## Test Cases

- Case A
- Edge case
- ...

## To Do

_Any remaining things that need to get done_

- [ ] item 1
- [ ] ...

## Checklist

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.

- [ ] No merge conflicts
- [ ] All checks passing
- [ ] Remove any non-applicable sections of this template
- [ ] Assign the PR to yourself
- [ ] Request reviewers & ping on Slack
- [ ] PR is linked to the ticket (fill in the closes line below)

Closes # (issue #)
58 changes: 58 additions & 0 deletions .github/workflows/calypso-build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
#
name: Create and publish Calypso docker image

on:
push:
branches: ['Develop']
path:
- "Dockerfile"
workflow_dispatch:

# Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds.
env:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}

# There is a single job in this workflow. It's configured to run on the latest available version of Ubuntu.
jobs:
build-and-push-image:
runs-on: ubuntu-latest
# Sets the permissions granted to the `GITHUB_TOKEN` for the actions in this job.
permissions:
contents: read
packages: write
#
steps:
- name: Set up Docker Buildx
uses: docker/[email protected]
- name: Checkout repository
uses: actions/checkout@v4
# Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here.
- name: Log in to the Container registry
uses: docker/[email protected]
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
# This step uses [docker/metadata-action](https://github.com/docker/metadata-action#about) to extract tags and labels that will be applied to the specified image. The `id` "meta" allows the output of this step to be referenced in a subsequent step. The `images` value provides the base name for the tags and labels.
- name: Extract metadata (tags, labels) for Docker
id: meta
uses: docker/[email protected]
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
# This step uses the `docker/build-push-action` action to build the image, based on your repository's `Dockerfile`. If the build succeeds, it pushes the image to GitHub Packages.
# It uses the `context` parameter to define the build's context as the set of files located in the specified path. For more information, see "[Usage](https://github.com/docker/build-push-action#usage)" in the README of the `docker/build-push-action` repository.
# It uses the `tags` and `labels` parameters to tag and label the image with the output from the "meta" step.
- name: Build and push Docker image for Calypso
uses: docker/[email protected]
with:
context: ./
push: true
platforms: linux/arm64,linux/amd64
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
# for caching
# cache-from: type=gha
# cache-to: type=gha,mode=max
# https://github.com/docker/build-push-action/issues/820
provenance: false
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,8 @@ decode_data.rs
encode_data.rs
encode_master_mapping.rs
format_data.rs
simulate_data.rs

# my dumb script
./format
/privatetest/
2 changes: 1 addition & 1 deletion .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[submodule "Embedded-Base"]
path = Embedded-Base
url = https://github.com/Northeastern-Electric-Racing/Embedded-Base
url = ../Embedded-Base
Loading

0 comments on commit 94ce9ea

Please sign in to comment.