-
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.
- Loading branch information
Showing
19 changed files
with
439 additions
and
238 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,49 @@ | ||
name: Bug Report | ||
description: Report a bug or unexpected behavior in typed_argparser | ||
labels: [bug, pending] | ||
|
||
body: | ||
- type: markdown | ||
attributes: | ||
value: Thank you for contributing to typed_argparser! | ||
|
||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Description | ||
description: | | ||
Please explain what you're seeing and what you would expect to see. | ||
Please provide as much detail as possible to make understanding and solving your problem as quick as possible. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: example | ||
attributes: | ||
label: Example Code | ||
description: > | ||
If applicable, please add a self-contained, | ||
[minimal, reproducible, example](https://stackoverflow.com/help/minimal-reproducible-example) | ||
demonstrating the bug. | ||
placeholder: | | ||
from typed_argparser import argparser | ||
... | ||
render: Python | ||
|
||
- type: textarea | ||
id: version | ||
attributes: | ||
label: Python, typed_argparser & OS Version | ||
description: | | ||
Which version of Python & typed_argparser are you using, and which Operating System? | ||
Please run the following command for the version and copy the output below: | ||
```bash | ||
python -c "import typed_argparser; print(typed_argparser.__version__)" | ||
``` | ||
render: Text | ||
validations: | ||
required: true |
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,5 @@ | ||
blank_issues_enabled: true | ||
contact_links: | ||
- name: Ask a Question | ||
url: "https://github.com/ajatkj/typed_argparser/discussions/new?category=q-a" | ||
about: Ask a question about how to use typed_argparser using github discussions |
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: Feature Request | ||
description: "Suggest a new feature for typed_argparser" | ||
labels: [feature request] | ||
|
||
body: | ||
- type: markdown | ||
attributes: | ||
value: Thank you for contributing to typed_argparser! | ||
|
||
- type: checkboxes | ||
id: searched | ||
attributes: | ||
label: Initial Checks | ||
description: | | ||
Just a few checks to make sure you need to create a feature request. | ||
options: | ||
- label: I have searched Google & GitHub for similar requests and couldn't find anything | ||
required: true | ||
|
||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Description | ||
description: | | ||
Please give as much detail as possible about the feature you would like to suggest. | ||
You might like to add: | ||
* A demo of how code might look when using the feature | ||
* Your use case(s) for the feature | ||
validations: | ||
required: true |
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,100 @@ | ||
# This workflow will install Python dependencies, run tests and lint with a variety of Python versions | ||
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python | ||
|
||
name: Test | ||
|
||
on: | ||
push: | ||
branches: ["main"] | ||
pull_request: | ||
branches: ["main"] | ||
|
||
jobs: | ||
test: | ||
runs-on: ubuntu-latest | ||
strategy: | ||
fail-fast: false | ||
matrix: | ||
os: [ubuntu, macos, windows] | ||
python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"] | ||
|
||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Set up Python ${{ matrix.python-version }} | ||
uses: actions/setup-python@v5 | ||
with: | ||
python-version: ${{ matrix.python-version }} | ||
- name: Install dependencies | ||
run: | | ||
python -m pip install --upgrade pip | ||
if [ -f requirements-dev.txt ]; then pip install -r requirements-dev.txt; fi | ||
- name: Lint | ||
run: | | ||
poe lint | ||
- run: mkdir coverage | ||
- name: Test | ||
run: | | ||
poe coverage | ||
poe coverage_report | ||
env: | ||
COVERAGE_FILE: coverage/.coverage.${{ runner.os }}-py${{ matrix.python-version }} | ||
CONTEXT: ${{ runner.os }}-py${{ matrix.python-version }} | ||
|
||
- name: store coverage files | ||
uses: actions/upload-artifact@v4 | ||
with: | ||
name: coverage-${{ matrix.os }}-${{ matrix.python-version }} | ||
path: coverage | ||
|
||
coverage-combine: | ||
needs: [test] | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Dump GitHub context | ||
env: | ||
GITHUB_CONTEXT: ${{ toJson(github) }} | ||
run: echo "$GITHUB_CONTEXT" | ||
- uses: actions/checkout@v4 | ||
- uses: actions/setup-python@v5 | ||
with: | ||
python-version: "3.8" | ||
- name: Get coverage files | ||
uses: actions/download-artifact@v4 | ||
with: | ||
merge-multiple: true | ||
pattern: coverage-* | ||
path: coverage | ||
- run: pip install coverage[toml] | ||
- run: ls -la coverage | ||
- run: coverage combine coverage | ||
- run: coverage report | ||
- run: coverage html --show-contexts --title "typed-argparser coverage for ${{ github.sha }}" | ||
- name: Store coverage html | ||
uses: actions/upload-artifact@v4 | ||
with: | ||
name: coverage-html | ||
path: htmlcov | ||
- name: Upload coverage reports to Codecov | ||
uses: codecov/[email protected] | ||
env: | ||
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} | ||
with: | ||
verbose: true | ||
|
||
# https://github.com/marketplace/actions/alls-green | ||
check: # This job does nothing and is only used for the branch protection | ||
if: always() | ||
needs: | ||
- coverage-combine | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Dump GitHub context | ||
env: | ||
GITHUB_CONTEXT: ${{ toJson(github) }} | ||
run: echo "$GITHUB_CONTEXT" | ||
- name: Decide whether the needed jobs succeeded or failed | ||
uses: re-actors/alls-green@release/v1 | ||
id: all-green | ||
with: | ||
jobs: ${{ toJSON(needs) }} |
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 |
---|---|---|
|
@@ -18,4 +18,4 @@ build | |
.cache | ||
|
||
# macOS | ||
.DS_Store | ||
.DS_Store |
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
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
Oops, something went wrong.