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

Move CI from travis-ci to Github Actions #868

Merged
merged 5 commits into from
Nov 30, 2020
Merged

Conversation

prjemian
Copy link
Contributor

fixes #867

@prjemian prjemian marked this pull request as draft November 17, 2020 16:27
@prjemian
Copy link
Contributor Author

Not ready for review or merge, yet. Take a look, though, it is working! Much faster completion time that travis now.

.github/workflows/syntax-checks.yml Show resolved Hide resolved
source $CONDA/bin/activate $ENV_NAME
make makebuilddir
pushd build/manual
# CI needs latexmk to execute next line
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found on WSL2 with Ubunutu 20.04.1 that I needed these packages to build the PDFs

python3-lxml
python-is-python3
python3-pip
xsltproc
texlive-latex-extra
latexmk
xindy

then used

$ pip3 install --user sphinx

And added ~/.local/bin to PATH

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to try and keep the setup to using pip rather than the ubuntu-specific packages. This would make transition to other build OS more consistent.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But, some things, such as texlive-latex-extra and latexmk are unavoidable. What is xindy?

Copy link
Contributor

@PeterC-DLS PeterC-DLS Nov 17, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think one of the style files used by sphinx required it for index processing

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep that in mind when/if we change the CI instructions to use the OS-provided toolset and not conda. Since the docs build in full with no errors now using the conda toolset, it's not necessary to use the OS-provided python toolset.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to build the PDF documentation during these syntax checks? We're not publishing from this workflow. Can we leave out this step until we decide to publish the docs from this workflow (related to #663)?

@prjemian prjemian requested a review from PeterC-DLS November 19, 2020 17:37
@prjemian prjemian marked this pull request as ready for review November 19, 2020 17:37
@prjemian
Copy link
Contributor Author

All existing test steps pass now. Ready for review.

@prjemian
Copy link
Contributor Author

Note (thanks to @danielballan):

Debug your GitHub actions over SSH: https://github.com/marketplace/actions/debugging-with-tmate

@prjemian
Copy link
Contributor Author

Example python project that runs GH Actions without using conda: https://github.com/bluesky/ophyd/tree/master/.github/workflows

Copy link
Contributor

@PeterC-DLS PeterC-DLS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@prjemian prjemian merged commit 1ee405d into master Nov 30, 2020
@prjemian prjemian deleted the 867-CI-GithubActions branch November 30, 2020 21:09
@prjemian prjemian added this to the NXDL 2021.10 milestone Mar 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

change CI from travis-ci to Github Actions (or other)
2 participants