Skip to content

Commit a2123ec

Browse files
authored
Merge pull request #107 from jepler/modernize
we now recommend github actions as the CI system of choice
2 parents b49cd84 + 6a40797 commit a2123ec

File tree

5 files changed

+13
-34
lines changed

5 files changed

+13
-34
lines changed

.github/workflows/build.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ jobs:
1515
env:
1616
GITHUB_CONTEXT: ${{ toJson(github) }}
1717
run: echo "$GITHUB_CONTEXT"
18-
- name: Set up Python 3.7
18+
- name: Set up Python 3.10
1919
uses: actions/setup-python@v5
2020
with:
21-
python-version: 3.7
21+
python-version: "3.10"
2222
- name: Versions
2323
run: |
2424
python3 --version

.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
- name: Set up Python
1818
uses: actions/setup-python@v5
1919
with:
20-
python-version: '3.7'
20+
python-version: '3.10'
2121
- name: Install dependencies
2222
run: |
2323
python -m pip install --upgrade pip

README.md

Lines changed: 9 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4,40 +4,20 @@
44

55
This repo contains build scripts used to build the
66
[Adafruit CircuitPython bundle](https://github.com/adafruit/Adafruit_CircuitPython_Bundle), [CircuitPython Community bundle](https://github.com/adafruit/CircuitPython_Community_Bundle)
7-
and individual library release zips. Its focused on Travis CI support but will also work locally
7+
and individual library release zips. Its focused on Github Actions support but will also work locally
88
when a gcc compiler is present.
99

10-
The pip package includes mpy-crosses that run on Travis. When building locally, the scripts will
10+
The scripts will either fetch a pre-built mpy-cross from s3 or
1111
automatically clone the [CircuitPython repo](https://github.com/adafruit/circuitpython) and attempt
12-
to build mpy-crosses. You'll need some version of gcc for this to work.
12+
to build mpy-cross. You'll need some version of gcc for this to work.
1313

1414
## Setting up libraries
1515

16-
These build tools are intended for use with [Travis CI](https://travis-ci.org)
17-
to automatically build .mpy files and zip them up for CircuitPython when a new
18-
tagged release is created. To add support to a repo you need to:
19-
20-
1. Use the [CircuitPython cookiecutter](https://github.com/adafruit/cookiecutter-adafruit-circuitpython) to generate .travis.yml.
21-
2. For adafruit repositories, simply give the CircuitPythonLibrarians team
22-
write access to the repo and Adabot will do the rest.
23-
24-
Otherwise, go to travis-ci.org and find the repository (it needs to be
25-
setup to access your github account, and your github account needs access
26-
to write to the repo). Flip the 'ON' switch on for Travis and the repo,
27-
see the Travis docs for more details: https://docs.travis-ci.com/user/getting-started/
28-
3. Get a GitHub 'personal access token' which has at least 'public_repo' or
29-
'repo' scope: https://help.github.com/articles/creating-an-access-token-for-command-line-use/
30-
Keep this token safe and secure! Anyone with the token will be able to
31-
access and write to your GitHub repositories. Travis will use the token
32-
to attach the .mpy files to the release.
33-
4. In the Travis CI settings for the repository that was enabled find the
34-
environment variable editing page: https://docs.travis-ci.com/user/environment-variables/#Defining-Variables-in-Repository-Settings
35-
Add an environment variable named GITHUB_TOKEN and set it to the value
36-
of the GitHub personal access token above. Keep 'Display value in build
37-
log' flipped off.
38-
5. That's it! Tag a release and Travis should go to work to add zipped .mpy files
39-
to the release. It takes about a 2-3 minutes for a worker to spin up,
40-
build mpy-cross, and add the binaries to the release.
16+
These build tools automatically build .mpy files and zip them up for
17+
CircuitPython when a new tagged release is created. To add support to a repo
18+
you need to use the [CircuitPython
19+
cookiecutter](https://github.com/adafruit/cookiecutter-adafruit-circuitpython)
20+
to generate `.github/workflows/*.yml`.
4121

4222
The bundle build will produce one zip file for every major CircuitPython
4323
release supported containing compatible mpy files and a zip with human readable py files.
@@ -71,5 +51,5 @@ circuitpython-build-bundles --filename_prefix <output file prefix> --library_loc
7151
## Contributing
7252

7353
Contributions are welcome! Please read our [Code of Conduct]
74-
(https://github.com/adafruit/Adafruit_CircuitPython_adabot/blob/master/CODE_OF_CONDUCT.md)
54+
(https://github.com/adafruit/Adafruit\_CircuitPython\_adabot/blob/master/CODE\_OF\_CONDUCT.md)
7555
before contributing to help this project stay welcoming.

requirements.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,3 @@ requests
33
semver
44
wheel
55
tomli; python_version < "3.11"
6-
importlib_metadata; python_version < "3.8"

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
'circuitpython_build_tools.scripts'],
1414
package_data={'circuitpython_build_tools': ['data/mpy-cross-*']},
1515
zip_safe=False,
16-
python_requires='>=3.7',
16+
python_requires='>=3.10',
1717
install_requires=['Click', 'requests', 'semver', 'tomli; python_version < "3.11"'],
1818
entry_points='''
1919
[console_scripts]

0 commit comments

Comments
 (0)