added contributing and code of conduct #22
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: xBFreE Project | |
on: | |
push: | |
branches: | |
- master | |
env: | |
PYTHON_VERSION: 3.x | |
jobs: | |
documentation: | |
name: Build documentation | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v2 | |
with: | |
# Number of commits to fetch. 0 indicates all history. For mkdocs-git-revision-date-localized-plugin | |
# Default: 1 | |
fetch-depth: 0 | |
- name: Set up Python runtime | |
uses: actions/setup-python@v1 | |
with: | |
python-version: ${{ env.PYTHON_VERSION }} | |
- name: Install Python dependencies | |
run: | | |
pip install -r ./docs/requirements.txt | |
- name: Deploy documentation | |
env: | |
GOOGLE_ANALYTICS_KEY: ${{ secrets.GOOGLE_ANALYTICS_KEY }} | |
run: | | |
mkdocs gh-deploy --force | |
mkdocs --version |