Documentation with Github Actions #172
Closed
Conversation
This file contains 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
|
Problems -
|
ErikBjare
requested changes
Mar 31, 2021
Comment on lines
-1
to
-38
| name: Test | ||
|
|
||
| on: | ||
| push: | ||
| branches: [master] | ||
| pull_request: | ||
| branches: [master] | ||
|
|
||
| jobs: | ||
| test: | ||
| name: ${{ matrix.os }}, py-${{ matrix.python-version }} | ||
| runs-on: ${{ matrix.os }} | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| os: [ubuntu-18.04, windows-latest, macOS-latest] | ||
| python-version: ["3.6", "3.7", "3.8", "3.9"] | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - name: Setup Python | ||
| uses: actions/setup-python@v2 | ||
| with: | ||
| python-version: ${{ matrix.python-version }} | ||
| - uses: pre-commit/[email protected] | ||
| - name: Install dependencies | ||
| shell: bash | ||
| run: | | ||
| python -m pip install --upgrade pip poetry wheel | ||
| poetry config virtualenvs.create false | ||
| poetry install | ||
| - name: Run tests | ||
| shell: bash | ||
| run: | | ||
| python -m unittest moabb.tests | ||
| - name: Run pipelines | ||
| shell: bash | ||
| run: | | ||
| python -m moabb.run --pipelines=./moabb/tests/test_pipelines/ --verbose |
| push: | ||
| branches: [master] | ||
| pull_request: | ||
| branches: [master] |
There was a problem hiding this comment.
Docs should be built but not deployed on PRs.
Comment on lines
+1
to
+4
| matplotlib | ||
| sphinx_bootstrap_theme | ||
| git | ||
| git+https://github.com/NeuroTechX/moabb |
There was a problem hiding this comment.
These dependencies are already in pyproject.toml, why keep a separate requirements.txt?
Comment on lines
+35
to
+46
| - name: Commit documentation changes | ||
| run: | | ||
| git clone https://github.com/NeuroTechX/moabb.github.io.git --branch master --single-branch master | ||
| cp -r docs/_build/html/* master/ | ||
| cd master | ||
| touch .nojekyll | ||
| git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com" | ||
| git config --global user.name "github-actions[bot]" | ||
| git add . | ||
| git commit -m "Update documentation" -a || true | ||
| # The above command will fail if no changes were present, so we ignore | ||
| # that. |
There was a problem hiding this comment.
There are good actions for this (to avoid the mess), see for example: NeuroTechX/EEG-ExPy#62
Deploy should also only happen on master branch, see: https://github.com/NeuroTechX/eeg-notebooks/pull/62/files#r540869378
Suggested change
| - name: Commit documentation changes | |
| run: | | |
| git clone https://github.com/NeuroTechX/moabb.github.io.git --branch master --single-branch master | |
| cp -r docs/_build/html/* master/ | |
| cd master | |
| touch .nojekyll | |
| git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com" | |
| git config --global user.name "github-actions[bot]" | |
| git add . | |
| git commit -m "Update documentation" -a || true | |
| # The above command will fail if no changes were present, so we ignore | |
| # that. | |
| - name: Deploy | |
| uses: peaceiris/actions-gh-pages@v3 | |
| if: github.ref == 'refs/heads/master' | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: docs/_build/html |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 does the part of building the docs and committing to moabb.github.io repo from where the GH page works. Pushing not yet done.
Closes #78