Create a GitHub Actions setup: build documentation, executables on Linux and MacOS #1049
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Create a GitHub Actions workflow to build and deploy the doc/ directory. The documentation is built using Sphinx. The resulting directory with the web assets is deployed to GitHub Pages.
Create a GitHub Actions workflow that builds Neper on Linux. It is built with a minimal configuration for x86 and arm64 architectures. Some tests fail since no optional runtime dependencies are installed.
Create a GitHub Actions workflow that builds Neper on MacOS. It is built with a minimal configuration for x86 and arm64 architectures. Some tests fail since no optional runtime dependencies are installed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull requests consists of 3 commits that add GitHub Actions workflows.
.github/workflows/runner.yamlworkflow that will orchestrate all other workflows.Moreover, it adds a workflow that builds the Neper documentation in
doc/and, if configured, deploys it to a GitHub Pages website.(I understand that the deployment logic is currently in the
gh-pagesbranch whwre the whole website resides, not only documentation. However, I believe that deploying the documentation automatically via GitHub Actions is a step forward.)For this the workflow file
.github/workflows/website.yamlis created (together with the helper scrtipt.github/scripts/check-pages-enabled.sh), and called by.github/workflows/runner.yaml.Ubuntu Linuxonarm64andx86_64architectures in the file.github/workflows/linux.yaml, called in.github/workflows/runner.yaml.Currently the configuration is minimal (without any optional runtime dependencies) which makes some tests fail.
Failed tests are ignored in order to finish the workflow and upload the final executable.
I am not sure whether the final executable can be freely run, but at this stage this workflow is an initial step towards a full GitHub Actions automation.
MacOSonarm64andx86_64architectures in the file.github/workflows/macos.yaml, called in.github/workflows/runner.yaml.Everything said in the previous point applies here as well.