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

Add GitHub actions #474

Merged
merged 5 commits into from
Mar 1, 2020
Merged

Add GitHub actions #474

merged 5 commits into from
Mar 1, 2020

Conversation

D4N
Copy link
Contributor

@D4N D4N commented Feb 2, 2020

To prevent issues due to changes in sphinx between compatible versions, I've created a github action workflow that will run the tests against all supported sphinx versions and all supported python versions. Running the tests against Sphinx 1.8.x actually failed, so I raised the required version to 2.0.

Furthermore, I've added workflows to build breathe's documentation and run flake8.

Example runs: https://github.com/D4N/breathe/actions

@jakobandersen
Copy link
Collaborator

Note that Sphinx officially only supports the newest version, currently 2.3.1, but it is of course nice to see how old versions Breathe actually works with.
I'm not sure if it is possible, but it may be interesting to test with the 2.0 branch (from which version 2.4 will be released) and the master branch (future 3.0) of Sphinx as well to prepare for potential breakages.

@D4N
Copy link
Contributor Author

D4N commented Feb 3, 2020

@jakobandersen I like your idea, gave it a shot and immediately ran into a breakage that will have to be fixed on the next release: https://github.com/D4N/breathe/runs/424152924?check_suite_focus=true

I have therefore commented the devel branches out, as github actions do not appear to support an "allow failures" mode for certain steps.

@vermeeren vermeeren self-assigned this Mar 1, 2020
@vermeeren vermeeren added analysis Quality assurance, CI enhancement Improvements, additions (also cosmetics) labels Mar 1, 2020
@vermeeren
Copy link
Collaborator

Thanks for the patches, just checked them and all seems good to me, so merging. If you find any improvements in the future feel free to open up another PR.

@vermeeren vermeeren merged commit 35f8a8a into breathe-doc:master Mar 1, 2020
vermeeren added a commit that referenced this pull request Mar 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
analysis Quality assurance, CI enhancement Improvements, additions (also cosmetics)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants