-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added github actions and github templates
- Loading branch information
Showing
5 changed files
with
110 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
20 changes: 20 additions & 0 deletions
20
{{cookiecutter.git_repo_name}}/.github/ISSUE_TEMPLATE/bug_form.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Bug Report | ||
description: File a bug report | ||
title: "[Bug]: " | ||
labels: ["bug"] | ||
body: | ||
- type: textarea | ||
attributes: | ||
label: Describe Problem | ||
description: What problem did you have? | ||
placeholder: Something is broken. | ||
validations: | ||
required: true | ||
- type: input | ||
attributes: | ||
label: Version | ||
description: What version of our software are you running? | ||
placeholder: 1.0.0 | ||
validations: | ||
required: true |
12 changes: 12 additions & 0 deletions
12
{{cookiecutter.git_repo_name}}/.github/ISSUE_TEMPLATE/config.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
blank_issues_enabled: true | ||
contact_links: | ||
- name: Python Information | ||
url: https://www.python.org/ | ||
about: Python Org Website | ||
- name: FastAPI Information | ||
url: https://fastapi.tiangolo.com/ | ||
about: FastAPI Website | ||
- name: pydantic Information | ||
url: https://pydantic-docs.helpmanual.io/ | ||
about: pydantic Website |
25 changes: 25 additions & 0 deletions
25
{{cookiecutter.git_repo_name}}/.github/pull_request_template.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Description | ||
|
||
Please include a summary of the change and which issue is fixed if applicable. Please also include relevant motivation | ||
and context. | ||
|
||
List any dependencies that are required for this change. | ||
|
||
Fixes # (issue) | ||
|
||
## Type of change | ||
|
||
- [ ] New feature (non-breaking change which adds functionality) | ||
- [ ] Bug fix (non-breaking change which fixes an issue) | ||
- [ ] Possible Breaking change (fix or feature that could cause existing functionality to not work as expected) | ||
|
||
# Checklist: | ||
|
||
- [ ] My code follows the style guidelines | ||
- [ ] I have updated the requirements.txt | ||
- [ ] I have updated the setup.py | ||
- [ ] I have updated the requirements-dev.txt | ||
- [ ] I have linted my code | ||
- [ ] I have written unit-tests for python code | ||
- [ ] I have verified code coverage | ||
- [ ] I have updated the documents |
49 changes: 49 additions & 0 deletions
49
{{cookiecutter.git_repo_name}}/.github/workflows/test-coverage-lint.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# This workflow will install Python dependencies, run tests and lint with a variety of Python versions | ||
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions | ||
|
||
name: Unit-Testing, Coverage, Linting | ||
|
||
on: | ||
push: | ||
branches: | ||
- master | ||
- develop | ||
- feature/* | ||
- bug/* | ||
pull_request: | ||
branches: | ||
- master | ||
- develop | ||
- feature/* | ||
- bug/* | ||
|
||
jobs: | ||
build: | ||
|
||
runs-on: ubuntu-latest | ||
strategy: | ||
matrix: | ||
python-version: | ||
- 3.7 | ||
- 3.8 | ||
- 3.9 | ||
- '3.10' | ||
|
||
steps: | ||
- uses: actions/checkout@v3 | ||
- name: Set up Python ${{ matrix.python-version }} | ||
uses: actions/setup-python@v4 | ||
with: | ||
python-version: ${{ matrix.python-version }} | ||
- name: Upgrade pip setuptools wheel | ||
run: | | ||
python -m pip install --upgrade pip setuptools wheel | ||
- name: Install requirements from requirements-dev.txt | ||
run: | | ||
pip install -r requirements-dev.txt | ||
- name: Run Linting | ||
run: | | ||
make pylint | ||
- name: Run Unit-Testing and Coverage | ||
run: | | ||
make coverage |