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

feature CI documentation #867

Merged
merged 12 commits into from
Apr 6, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Documentation Workflow
on:
push:
branches:
- develop
- develop-ref
- feature_*
- main_*
- bugfix_*
paths:
- docs/**
pull_request:
types: [opened, reopened, synchronize]

jobs:
documentation:
name: Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
with:
python-version: '3.6'
- name: Install dependencies
run: |
python -m pip install --upgrade sphinx sphinx-gallery sphinx_rtd_theme
python -m pip install python-dateutil requests Pillow
- name: Build Documentation
continue-on-error: true
run: ./.github/jobs/build_documentation.sh
- uses: actions/upload-artifact@v2
with:
name: METplus_documentation
path: artifact/documentation
- uses: actions/upload-artifact@v2
with:
name: documentation_warnings.log
path: artifact/doc_warnings.log
if-no-files-found: ignore
37 changes: 3 additions & 34 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: METplus CI/CD Workflow
name: Testing Workflow
on:
push:
branches:
Expand All @@ -7,6 +7,8 @@ on:
- feature_*
- main_*
- bugfix_*
paths-ignore:
- docs/**
pull_request:
types: [opened, reopened, synchronize]

Expand All @@ -29,39 +31,6 @@ jobs:
with:
name: job_control_status
path: job_control_status

documentation:
name: Documentation
runs-on: ubuntu-latest
needs: job_control
steps:
- uses: actions/download-artifact@v2
with:
name: job_control_status
- run: cat job_control_status >> $GITHUB_ENV
- uses: actions/checkout@v2
if: ${{ env.run_docs == 'true' }}
- uses: actions/setup-python@v2
if: ${{ env.run_docs == 'true' }}
with:
python-version: '3.6'
- name: Install dependencies
if: ${{ env.run_docs == 'true' }}
run: |
python -m pip install --upgrade python-dateutil requests sphinx sphinx-gallery Pillow sphinx_rtd_theme
- name: Build Documentation
if: ${{ env.run_docs == 'true' }}
continue-on-error: true
run: ./.github/jobs/build_documentation.sh
- uses: actions/upload-artifact@v2
with:
name: METplus_documentation
path: artifact/documentation
- uses: actions/upload-artifact@v2
with:
name: documentation_warnings.log
path: artifact/doc_warnings.log
if-no-files-found: ignore
get_image:
name: Docker Setup - Get METplus Image
runs-on: ubuntu-latest
Expand Down