Integrate BioNLPProcessor with Odinson #19
Workflow file for this run
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
name: Project documentation | |
on: | |
push: | |
branches: [master] | |
pull_request: | |
branches: [master] | |
# Allows you to run this workflow manually from the Actions tab | |
workflow_dispatch: | |
# # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
# permissions: | |
# contents: read | |
# pages: write | |
# id-token: write | |
jobs: | |
docs: | |
name: "Generate project documenation" | |
runs-on: ${{ matrix.os }} | |
strategy: | |
matrix: | |
os: [ubuntu-latest] | |
python-version: [ '3.9' ] | |
steps: | |
# Checkout code | |
- name: Checkout code | |
uses: actions/checkout@v3 | |
- name: Set up Python | |
uses: actions/setup-python@v2 | |
with: | |
python-version: ${{ matrix.python-version }} | |
#architecture: x64 | |
- name: Display Python version | |
run: | | |
python -c "import sys; print(sys.version)" | |
# - name: Setup JDK | |
# uses: actions/setup-java@v3 | |
# with: | |
# distribution: temurin | |
# java-version: 11 | |
# Install dependencies | |
- name: Doc deps | |
working-directory: "./docs" | |
run: | | |
pip install -r requirements.txt | |
# docs (API) | |
# generate python docs using pdoc | |
# - name: "Create API docs" | |
# run: | | |
# sbt doc | |
# mkdir -p $GITHUB_WORKSPACE/docs/api/scala | |
# mv target/doc/* $GITHUB_WORKSPACE/docs/api/scala/ | |
# generate Rust docs using cargo doc | |
# code coverage (Scala) | |
# FIXME: downloading project deps is far too slow to include this step | |
# - name: "Code coverage reports for Scala components" | |
# working-directory: ./skema/text_reading/scala | |
# run: | | |
# sbt clean coverage test | |
# sbt coverageReport | |
# sbt coverageAggregate | |
# docs (other) | |
- name: "Create documentation (other)" | |
run: | | |
mkdocs build -c | |
- name: Deploy docs | |
if: github.ref == 'refs/heads/master' | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
# see https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow#about-the-github_token-secret | |
enable_jekyll: false | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./site | |
destination_dir: "docs" | |
user_name: 'github-actions[bot]' | |
user_email: 'github-actions[bot]@users.noreply.github.com' | |
commit_message: ${{ github.event.head_commit.message }} | |
#cname: docs.lum.ai |