Skip to content

Commit 59f04ea

Browse files
authored
Merge pull request #2 from adafruit/actionci
Moved repository to actions
2 parents 7586b00 + 4000119 commit 59f04ea

10 files changed

+1085
-1055
lines changed

.github/ISSUE_TEMPLATE.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
Thank you for opening an issue on an Adafruit Arduino library repository. To
2+
improve the speed of resolution please review the following guidelines and
3+
common troubleshooting steps below before creating the issue:
4+
5+
- **Do not use GitHub issues for troubleshooting projects and issues.** Instead use
6+
the forums at http://forums.adafruit.com to ask questions and troubleshoot why
7+
something isn't working as expected. In many cases the problem is a common issue
8+
that you will more quickly receive help from the forum community. GitHub issues
9+
are meant for known defects in the code. If you don't know if there is a defect
10+
in the code then start with troubleshooting on the forum first.
11+
12+
- **If following a tutorial or guide be sure you didn't miss a step.** Carefully
13+
check all of the steps and commands to run have been followed. Consult the
14+
forum if you're unsure or have questions about steps in a guide/tutorial.
15+
16+
- **For Arduino projects check these very common issues to ensure they don't apply**:
17+
18+
- For uploading sketches or communicating with the board make sure you're using
19+
a **USB data cable** and **not** a **USB charge-only cable**. It is sometimes
20+
very hard to tell the difference between a data and charge cable! Try using the
21+
cable with other devices or swapping to another cable to confirm it is not
22+
the problem.
23+
24+
- **Be sure you are supplying adequate power to the board.** Check the specs of
25+
your board and plug in an external power supply. In many cases just
26+
plugging a board into your computer is not enough to power it and other
27+
peripherals.
28+
29+
- **Double check all soldering joints and connections.** Flakey connections
30+
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.
31+
32+
- **Ensure you are using an official Arduino or Adafruit board.** We can't
33+
guarantee a clone board will have the same functionality and work as expected
34+
with this code and don't support them.
35+
36+
If you're sure this issue is a defect in the code and checked the steps above
37+
please fill in the following fields to provide enough troubleshooting information.
38+
You may delete the guideline and text above to just leave the following details:
39+
40+
- Arduino board: **INSERT ARDUINO BOARD NAME/TYPE HERE**
41+
42+
- Arduino IDE version (found in Arduino -> About Arduino menu): **INSERT ARDUINO
43+
VERSION HERE**
44+
45+
- List the steps to reproduce the problem below (if possible attach a sketch or
46+
copy the sketch code in too): **LIST REPRO STEPS BELOW**

.github/PULL_REQUEST_TEMPLATE.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Thank you for creating a pull request to contribute to Adafruit's GitHub code!
2+
Before you open the request please review the following guidelines and tips to
3+
help it be more easily integrated:
4+
5+
- **Describe the scope of your change--i.e. what the change does and what parts
6+
of the code were modified.** This will help us understand any risks of integrating
7+
the code.
8+
9+
- **Describe any known limitations with your change.** For example if the change
10+
doesn't apply to a supported platform of the library please mention it.
11+
12+
- **Please run any tests or examples that can exercise your modified code.** We
13+
strive to not break users of the code and running tests/examples helps with this
14+
process.
15+
16+
Thank you again for contributing! We will try to test and integrate the change
17+
as soon as we can, but be aware we have many GitHub repositories to manage and
18+
can't immediately respond to every request. There is no need to bump or check in
19+
on a pull request (it will clutter the discussion of the request).
20+
21+
Also don't be worried if the request is closed or not integrated--sometimes the
22+
priorities of Adafruit's GitHub code (education, ease of use) might not match the
23+
priorities of the pull request. Don't fret, the open source community thrives on
24+
forks and GitHub makes it easy to keep your changes in a forked repo.
25+
26+
After reviewing the guidelines above you can delete this text from the pull request.

.github/workflows/githubci.yml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Arduino Library CI
2+
3+
on: [pull_request, push, repository_dispatch]
4+
5+
jobs:
6+
build:
7+
runs-on: ubuntu-latest
8+
9+
steps:
10+
- uses: actions/setup-python@v1
11+
with:
12+
python-version: '3.x'
13+
- uses: actions/checkout@v2
14+
- uses: actions/checkout@v2
15+
with:
16+
repository: adafruit/ci-arduino
17+
path: ci
18+
19+
- name: pre-install
20+
run: bash ci/actions_install.sh
21+
22+
- name: test platforms
23+
run: python3 ci/build_platform.py main_platforms
24+
25+
- name: clang
26+
run: python3 ci/run-clang-format.py -e "ci/*" -e "bin/*" -r .
27+
28+
- name: doxygen
29+
env:
30+
GH_REPO_TOKEN: ${{ secrets.GH_REPO_TOKEN }}
31+
PRETTYNAME : "Adafruit MFRC630 Library"
32+
run: bash ci/doxy_gen_and_deploy.sh

.travis.yml

-26
This file was deleted.

0 commit comments

Comments
 (0)