generated from ApeWorX/project-template
-
-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit fce517e
Showing
22 changed files
with
997 additions
and
0 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
name: Bug report | ||
about: Report an error that you've encountered. | ||
labels: 'bug' | ||
--- | ||
### Environment information | ||
|
||
* `ape` and plugin versions: | ||
|
||
``` | ||
$ ape --version | ||
# ...copy and paste result of above command here... | ||
$ ape plugins list | ||
# ...copy and paste result of above command here... | ||
``` | ||
|
||
* Python Version: x.x.x | ||
* OS: osx/linux/win | ||
|
||
### What went wrong? | ||
|
||
Please include information like: | ||
|
||
* what command you ran | ||
* the code that caused the failure (see [this link](https://help.github.com/articles/basic-writing-and-formatting-syntax/) for help with formatting code) | ||
* full output of the error you received | ||
|
||
### How can it be fixed? | ||
|
||
Fill this in if you have ideas on how the bug could be fixed. |
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,22 @@ | ||
--- | ||
name: Feature request | ||
about: Request a new feature, or an improvement to existing functionality. | ||
labels: 'enhancement' | ||
--- | ||
|
||
### Overview | ||
|
||
Provide a simple overview of what you wish to see added. Please include: | ||
|
||
* What you are trying to do | ||
* Why Ape's current functionality is inadequate to address your goal | ||
|
||
### Specification | ||
|
||
Describe the syntax and semantics of how you would like to see this feature implemented. The more detailed the better! | ||
|
||
Remember, your feature is much more likely to be included if it does not involve any breaking changes. | ||
|
||
### Dependencies | ||
|
||
Include links to any open issues that must be resolved before this feature can be implemented. |
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,41 @@ | ||
--- | ||
name: Work item | ||
about: New work item for Ape team | ||
labels: 'backlog' | ||
|
||
--- | ||
|
||
### Elevator pitch: | ||
<!-- 1-2 line summary of the scope of this work item --> | ||
|
||
### Value: | ||
<!-- | ||
Who is this for? | ||
Persona or group of people whom will derive value from the scenario. | ||
What benefits will be achieved or business metrics improved? | ||
--> | ||
|
||
### Dependencies: | ||
<!-- Call out key people, teams, tech dependencies, or assumptions. --> | ||
|
||
### Design approach: | ||
<!-- | ||
Free text / diagram / whiteboard picture / etc. that clearly shows your approach and considerations to build the task list. | ||
Existing code patterns in production code base that you will base your work off of. | ||
--> | ||
|
||
### Task list: | ||
<!-- Bulleted list describing the exit criteria, desired end state and any documentation, monitors, work for DRI, etc. that will need to be added to make sure someone else can support once it's live. --> | ||
* [ ] Tasks go here | ||
|
||
### Estimated completion date: | ||
|
||
|
||
### Design review: | ||
<!-- 1-2 people needed for signoff --> | ||
Do not signoff unless: | ||
- 1) agreed the tasks and design approach will achieve acceptance, and | ||
- 2) the work can be completed by one person within the SLA. | ||
Design reviewers should consider simpler approaches to achieve goals. | ||
|
||
(Please leave a comment to sign off) |
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,14 @@ | ||
### What I did | ||
|
||
Related issue: # | ||
|
||
### How I did it | ||
|
||
### How to verify it | ||
|
||
### Checklist | ||
|
||
- [ ] Passes all linting checks (pre-commit and CI jobs) | ||
- [ ] New test cases have been added and are passing | ||
- [ ] Documentation has been updated | ||
- [ ] PR title follows [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) standard (will be automatically included in the changelog) |
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,37 @@ | ||
name-template: '$RESOLVED_VERSION' | ||
tag-template: 'v$RESOLVED_VERSION' | ||
|
||
categories: | ||
- title: 'Features' | ||
labels: | ||
- 'feat' | ||
- title: 'Bug Fixes' | ||
labels: | ||
- 'fix' | ||
- title: 'Other updates' | ||
labels: | ||
- 'refactor' | ||
- 'chore' | ||
- 'docs' | ||
|
||
change-template: '- $TITLE @$AUTHOR (#$NUMBER)' | ||
change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks. | ||
|
||
version-resolver: | ||
major: | ||
labels: | ||
- 'major' | ||
minor: | ||
labels: | ||
- 'minor' | ||
patch: | ||
labels: | ||
- 'patch' | ||
default: patch | ||
|
||
template: | | ||
## Changes | ||
$CHANGES | ||
Special thanks to: $CONTRIBUTORS |
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 @@ | ||
on: push | ||
|
||
name: Commit Message | ||
|
||
# NOTE: Skip check on PR so as not to confuse contributors | ||
# NOTE: Also install a PR title checker so we don't mess up merges | ||
jobs: | ||
check: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v2 | ||
with: | ||
fetch-depth: 0 | ||
|
||
- name: Setup Python | ||
uses: actions/setup-python@v2 | ||
with: | ||
python-version: 3.8 | ||
|
||
- name: Install Dependencies | ||
run: pip install commitizen | ||
|
||
- name: Check commit history | ||
run: cz check --rev-range $(git rev-list --all --reverse | head -1)..HEAD |
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,17 @@ | ||
name: Release Drafter | ||
|
||
on: | ||
push: | ||
branches: | ||
- master | ||
|
||
jobs: | ||
update-draft: | ||
runs-on: ubuntu-latest | ||
steps: | ||
# Drafts your next Release notes as Pull Requests are merged into "master" | ||
- uses: release-drafter/release-drafter@v5 | ||
with: | ||
disable-autolabeler: true | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
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,32 @@ | ||
name: Release | ||
|
||
on: | ||
release: | ||
types: [released] | ||
|
||
jobs: | ||
deploy: | ||
|
||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v2 | ||
|
||
- name: Set up Python | ||
uses: actions/setup-python@v2 | ||
with: | ||
python-version: 3.8 | ||
|
||
- name: Install dependencies | ||
run: | | ||
python -m pip install --upgrade pip | ||
pip install -e .[release] | ||
- name: Build | ||
run: python setup.py sdist bdist_wheel | ||
|
||
- name: Publish | ||
env: | ||
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }} | ||
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }} | ||
run: twine upload dist/* --verbose |
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,86 @@ | ||
on: ["push", "pull_request"] | ||
|
||
name: Test | ||
|
||
jobs: | ||
linting: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v2 | ||
|
||
- name: Setup Python | ||
uses: actions/setup-python@v2 | ||
with: | ||
python-version: 3.8 | ||
|
||
- name: Install Dependencies | ||
run: pip install .[lint] | ||
|
||
- name: Run Black | ||
run: black --check . | ||
|
||
- name: Run flake8 | ||
run: flake8 . | ||
|
||
- name: Run isort | ||
run: isort --check-only . | ||
|
||
type-check: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v2 | ||
|
||
- name: Setup Python | ||
uses: actions/setup-python@v2 | ||
with: | ||
python-version: 3.8 | ||
|
||
- name: Install Dependencies | ||
run: pip install .[lint] | ||
|
||
- name: Run MyPy | ||
run: mypy . | ||
|
||
functional: | ||
runs-on: ubuntu-latest | ||
|
||
strategy: | ||
matrix: | ||
python-version: [3.6, 3.7, 3.8] | ||
|
||
steps: | ||
- uses: actions/checkout@v2 | ||
|
||
- name: Setup Python | ||
uses: actions/setup-python@v2 | ||
with: | ||
python-version: ${{ matrix.python-version }} | ||
|
||
- name: Install Dependencies | ||
run: pip install .[test] | ||
|
||
- name: Run Tests | ||
run: pytest -m "not fuzzing" | ||
|
||
# NOTE: uncomment this block after you've marked tests with @pytest.mark.fuzzing | ||
# fuzzing: | ||
# runs-on: ubuntu-latest | ||
# | ||
# strategy: | ||
# fail-fast: true | ||
# | ||
# steps: | ||
# - uses: actions/checkout@v2 | ||
# | ||
# - name: Setup Python | ||
# uses: actions/setup-python@v2 | ||
# with: | ||
# python-version: 3.8 | ||
# | ||
# - name: Install Dependencies | ||
# run: pip install .[test] | ||
# | ||
# - name: Run Tests | ||
# run: pytest -m "fuzzing" --no-cov -s |
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,28 @@ | ||
name: PR Title | ||
|
||
on: | ||
pull_request_target: | ||
types: | ||
- opened | ||
- edited | ||
- synchronize | ||
|
||
jobs: | ||
check: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v2 | ||
|
||
- name: Setup Python | ||
uses: actions/setup-python@v2 | ||
with: | ||
python-version: 3.8 | ||
|
||
- name: Install Dependencies | ||
run: pip install commitizen | ||
|
||
- name: Check PR Title | ||
env: | ||
TITLE: ${{ github.event.pull_request.title }} | ||
run: cz check --message "$TITLE" |
Oops, something went wrong.