-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #33 from makermelissa/master
Added Github Actions, Pylinted and Black Formatted.
- Loading branch information
Showing
14 changed files
with
699 additions
and
203 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,47 @@ | ||
Thank you for opening an issue on an Adafruit Python library repository. To | ||
improve the speed of resolution please review the following guidelines and | ||
common troubleshooting steps below before creating the issue: | ||
|
||
- **Do not use GitHub issues for troubleshooting projects and issues.** Instead use | ||
the forums at http://forums.adafruit.com to ask questions and troubleshoot why | ||
something isn't working as expected. In many cases the problem is a common issue | ||
that you will more quickly receive help from the forum community. GitHub issues | ||
are meant for known defects in the code. If you don't know if there is a defect | ||
in the code then start with troubleshooting on the forum first. | ||
|
||
- **If following a tutorial or guide be sure you didn't miss a step.** Carefully | ||
check all of the steps and commands to run have been followed. Consult the | ||
forum if you're unsure or have questions about steps in a guide/tutorial. | ||
|
||
- **For Python/Raspberry Pi projects check these very common issues to ensure they don't apply**: | ||
|
||
- If you are receiving an **ImportError: No module named...** error then a | ||
library the code depends on is not installed. Check the tutorial/guide or | ||
README to ensure you have installed the necessary libraries. Usually the | ||
missing library can be installed with the `pip` tool, but check the tutorial/guide | ||
for the exact command. | ||
|
||
- **Be sure you are supplying adequate power to the board.** Check the specs of | ||
your board and power in an external power supply. In many cases just | ||
plugging a board into your computer is not enough to power it and other | ||
peripherals. | ||
|
||
- **Double check all soldering joints and connections.** Flakey connections | ||
cause many mysterious problems. See the [guide to excellent soldering](https://learn.adafruit.com/adafruit-guide-excellent-soldering/tools) for examples of good solder joints. | ||
|
||
If you're sure this issue is a defect in the code and checked the steps above | ||
please fill in the following fields to provide enough troubleshooting information. | ||
You may delete the guideline and text above to just leave the following details: | ||
|
||
- Platform/operating system (i.e. Raspberry Pi with Raspbian operating system, | ||
Windows 32-bit, Windows 64-bit, Mac OSX 64-bit, etc.): **INSERT PLATFORM/OPERATING | ||
SYSTEM HERE** | ||
|
||
- Python version (run `python -version` or `python3 -version`): **INSERT PYTHON | ||
VERSION HERE** | ||
|
||
- Error message you are receiving, including any Python exception traces: **INSERT | ||
ERROR MESAGE/EXCEPTION TRACES HERE*** | ||
|
||
- List the steps to reproduce the problem below (if possible attach code or commands | ||
to run): **LIST REPRO STEPS BELOW** |
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,26 @@ | ||
Thank you for creating a pull request to contribute to Adafruit's GitHub code! | ||
Before you open the request please review the following guidelines and tips to | ||
help it be more easily integrated: | ||
|
||
- **Describe the scope of your change--i.e. what the change does and what parts | ||
of the code were modified.** This will help us understand any risks of integrating | ||
the code. | ||
|
||
- **Describe any known limitations with your change.** For example if the change | ||
doesn't apply to a supported platform of the library please mention it. | ||
|
||
- **Please run any tests or examples that can exercise your modified code.** We | ||
strive to not break users of the code and running tests/examples helps with this | ||
process. | ||
|
||
Thank you again for contributing! We will try to test and integrate the change | ||
as soon as we can, but be aware we have many GitHub repositories to manage and | ||
can't immediately respond to every request. There is no need to bump or check in | ||
on a pull request (it will clutter the discussion of the request). | ||
|
||
Also don't be worried if the request is closed or not integrated--sometimes the | ||
priorities of Adafruit's GitHub code (education, ease of use) might not match the | ||
priorities of the pull request. Don't fret, the open source community thrives on | ||
forks and GitHub makes it easy to keep your changes in a forked repo. | ||
|
||
After reviewing the guidelines above you can delete this text from the pull request. |
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,52 @@ | ||
name: Build CI | ||
|
||
on: [pull_request, push] | ||
|
||
jobs: | ||
test: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Dump GitHub context | ||
env: | ||
GITHUB_CONTEXT: ${{ toJson(github) }} | ||
run: echo "$GITHUB_CONTEXT" | ||
- name: Translate Repo Name For Build Tools filename_prefix | ||
id: repo-name | ||
run: echo ::set-output name=repo-name::circup | ||
- name: Set up Python 3.6 | ||
uses: actions/setup-python@v1 | ||
with: | ||
python-version: 3.6 | ||
- name: Versions | ||
run: | | ||
python3 --version | ||
- name: Checkout Current Repo | ||
uses: actions/checkout@v1 | ||
with: | ||
submodules: true | ||
- name: Checkout tools repo | ||
uses: actions/checkout@v2 | ||
with: | ||
repository: adafruit/actions-ci-circuitpython-libs | ||
path: actions-ci | ||
- name: Install dependencies | ||
# (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) | ||
run: | | ||
source actions-ci/install.sh | ||
- name: Pip install pylint, black, & Sphinx | ||
run: | | ||
pip install --force-reinstall pylint black==19.10b0 Sphinx sphinx-rtd-theme | ||
- name: Library version | ||
run: git describe --dirty --always --tags | ||
- name: Check formatting | ||
run: | | ||
black --check --target-version=py35 . | ||
- name: PyLint | ||
run: | | ||
pylint $( find . -path './circup.py' ) | ||
- name: Run Test Suite | ||
run: | | ||
make test | ||
- name: Build docs | ||
run: | | ||
make docs |
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,33 @@ | ||
name: Release Actions | ||
|
||
on: | ||
release: | ||
types: [published] | ||
|
||
jobs: | ||
upload-pypi: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v1 | ||
- name: Check For setup.py | ||
id: need-pypi | ||
run: | | ||
echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) | ||
- name: Set up Python | ||
if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') | ||
uses: actions/setup-python@v1 | ||
with: | ||
python-version: '3.x' | ||
- name: Install dependencies | ||
if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') | ||
run: | | ||
python -m pip install --upgrade pip | ||
pip install setuptools wheel twine | ||
- name: Build and publish | ||
if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') | ||
env: | ||
TWINE_USERNAME: ${{ secrets.pypi_username }} | ||
TWINE_PASSWORD: ${{ secrets.pypi_password }} | ||
run: | | ||
python setup.py sdist | ||
twine upload dist/* |
Oops, something went wrong.