Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Port CI to GitHub Actions and miscellaneous maintenance work #43

Merged
merged 9 commits into from Oct 24, 2023

Conversation

Bastian-Krause
Copy link
Member

This PR ports the Travis CI instructions to GitHub Actions. Also allow running the tests with recent tox versions and prepare them to run on forks without tags (i.e. for PRs).

While at it, add Python 3.11 support, fix some linter warnings and typos, update the badges in the README.

Signed-off-by: Bastian Krause <bst@pengutronix.de>
`git describe` will fail if no tags are available. This happens with
clones without tags, e.g. `git clone --no-tags [...]`, forks without
tags and is the default of actions/checkout@v4 [1].

Add the `--always` option to `git describe` to show the "uniquely
abbreviated commit object as fallback" [2].

[1] https://github.com/actions/checkout/blob/v4/README.md#usage
[2] https://git-scm.com/docs/git-describe#Documentation/git-describe.txt---always

Signed-off-by: Bastian Krause <bst@pengutronix.de>
Since tox 4, "packaging environments no longer inherit their settings
from the testenv section" [1]. This becomes an issue for flamingo
because the environment variable FLAMINGO_TEST is checked in its
setup.py.

Fix this by moving the setenv directive to the build environment
section. passenv= in flamingo is not affected because other env lookups
are performed outside of its setup.py.

[1] https://tox.wiki/en/4.11.3/upgrading.html#packaging-configuration-and-inheritance

Signed-off-by: Bastian Krause <bst@pengutronix.de>
Testing with Python 3.6 has been dropped a while ago, while Python 3.10
testing was added. Advertise these versions and adjust the tox
environments accordingly.

Fixes: ae476f3 (".travis: Python versions update")
Signed-off-by: Bastian Krause <bst@pengutronix.de>
Fix warnings emitted by `tox -e lint`. Use recommendations from
black [1] for affected lines only.

[1] https://github.com/psf/black

Signed-off-by: Bastian Krause <bst@pengutronix.de>
Signed-off-by: Bastian Krause <bst@pengutronix.de>
Signed-off-by: Bastian Krause <bst@pengutronix.de>
While at it, drop the sample comment and name the workflow accordingly.
This gets displayed unter the "actions" tab as well as on the status
badge.

Signed-off-by: Bastian Krause <bst@pengutronix.de>
Drop the now unused Travis and LGTM badges. Add badges for GitHub
actions CI and documentation build tests.

Signed-off-by: Bastian Krause <bst@pengutronix.de>
@codecov
Copy link

codecov bot commented Oct 1, 2023

Codecov Report

Attention: 43 lines in your changes are missing coverage. Please review.

Comparison is base (5c41ae6) 51.44% compared to head (7fa6c66) 50.78%.
Report is 19 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master      #43      +/-   ##
==========================================
- Coverage   51.44%   50.78%   -0.66%     
==========================================
  Files          66       66              
  Lines        4078     4125      +47     
  Branches      785      819      +34     
==========================================
- Hits         2098     2095       -3     
- Misses       1778     1822      +44     
- Partials      202      208       +6     
Files Coverage Δ
flamingo/__init__.py 100.00% <100.00%> (ø)
flamingo/plugins/sphinx_themes/sphinx_theme.py 22.64% <88.88%> (+0.34%) ⬆️
flamingo/plugins/tags/tags.py 50.00% <0.00%> (-4.55%) ⬇️
flamingo/plugins/feeds.py 27.83% <13.33%> (-25.87%) ⬇️

... and 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

flamingo/plugins/feeds.py Show resolved Hide resolved
@SmithChart SmithChart merged commit 1c6edfc into pengutronix:master Oct 24, 2023
7 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants