From 609fe9df385f494138d251e14894ff5a9671277f Mon Sep 17 00:00:00 2001 From: Steven Pestana <650301+spestana@users.noreply.github.com> Date: Mon, 3 Jul 2023 12:09:48 -0700 Subject: [PATCH 1/4] Create docs.yml --- .github/workflows/docs.yml | 61 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..5611546 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,61 @@ +name: docs + +# build the documentation whenever there are new commits on main +on: + push: + branches: + - re-org + # Alternative: only build for tags. + # tags: + # - '*' + +# security: restrict permissions for CI jobs. +permissions: + contents: read + +jobs: + # Build the documentation and upload the static HTML files as an artifact. + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Set up Python 3.10 + uses: actions/setup-python@v3 + with: + python-version: '3.10' + + # ADJUST THIS: install all dependencies (including pdoc) + - name: Add conda to system path + run: | + # $CONDA is an environment variable pointing to the root of the miniconda directory + echo $CONDA/bin >> $GITHUB_PATH + - name: Install mamba and dependencies + run: | + conda install mamba -c conda-forge + mamba env update --file environment.yml --name goesenv + source $CONDA/etc/profile.d/conda.sh + conda activate goesenv + pip install . + pip install pdoc3 + # ADJUST THIS: build your documentation into docs/. + # We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here. + - run: pdoc --html goes_ortho --force + + - uses: actions/upload-pages-artifact@v1 + with: + path: docs/ + + # Deploy the artifact to GitHub pages. + # This is a separate job so that only actions/deploy-pages has the necessary permissions. + deploy: + needs: build + runs-on: ubuntu-latest + permissions: + pages: write + id-token: write + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - id: deployment + uses: actions/deploy-pages@v2 From 85919186215db2e5c3962abd7cee1968fad8352d Mon Sep 17 00:00:00 2001 From: Steven Pestana <650301+spestana@users.noreply.github.com> Date: Mon, 3 Jul 2023 12:12:48 -0700 Subject: [PATCH 2/4] Update docs.yml --- .github/workflows/docs.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 5611546..83076d7 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -39,7 +39,9 @@ jobs: pip install pdoc3 # ADJUST THIS: build your documentation into docs/. # We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here. - - run: pdoc --html goes_ortho --force + - run: | + source $CONDA/etc/profile.d/conda.sh + pdoc --html goes_ortho --force - uses: actions/upload-pages-artifact@v1 with: From e68fd32a7094f5f91a882b11c141964e4f2dd7eb Mon Sep 17 00:00:00 2001 From: Steven Pestana <650301+spestana@users.noreply.github.com> Date: Mon, 3 Jul 2023 12:14:37 -0700 Subject: [PATCH 3/4] Delete docs.yml --- .github/workflows/docs.yml | 63 -------------------------------------- 1 file changed, 63 deletions(-) delete mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml deleted file mode 100644 index 83076d7..0000000 --- a/.github/workflows/docs.yml +++ /dev/null @@ -1,63 +0,0 @@ -name: docs - -# build the documentation whenever there are new commits on main -on: - push: - branches: - - re-org - # Alternative: only build for tags. - # tags: - # - '*' - -# security: restrict permissions for CI jobs. -permissions: - contents: read - -jobs: - # Build the documentation and upload the static HTML files as an artifact. - build: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - name: Set up Python 3.10 - uses: actions/setup-python@v3 - with: - python-version: '3.10' - - # ADJUST THIS: install all dependencies (including pdoc) - - name: Add conda to system path - run: | - # $CONDA is an environment variable pointing to the root of the miniconda directory - echo $CONDA/bin >> $GITHUB_PATH - - name: Install mamba and dependencies - run: | - conda install mamba -c conda-forge - mamba env update --file environment.yml --name goesenv - source $CONDA/etc/profile.d/conda.sh - conda activate goesenv - pip install . - pip install pdoc3 - # ADJUST THIS: build your documentation into docs/. - # We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here. - - run: | - source $CONDA/etc/profile.d/conda.sh - pdoc --html goes_ortho --force - - - uses: actions/upload-pages-artifact@v1 - with: - path: docs/ - - # Deploy the artifact to GitHub pages. - # This is a separate job so that only actions/deploy-pages has the necessary permissions. - deploy: - needs: build - runs-on: ubuntu-latest - permissions: - pages: write - id-token: write - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - steps: - - id: deployment - uses: actions/deploy-pages@v2 From eb4dce680cc8dafc46b688126d9ffe6b0d06a274 Mon Sep 17 00:00:00 2001 From: Steven Pestana <650301+spestana@users.noreply.github.com> Date: Thu, 9 May 2024 10:06:22 -0700 Subject: [PATCH 4/4] Create pylint.yml --- .github/workflows/pylint.yml | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 .github/workflows/pylint.yml diff --git a/.github/workflows/pylint.yml b/.github/workflows/pylint.yml new file mode 100644 index 0000000..c73e032 --- /dev/null +++ b/.github/workflows/pylint.yml @@ -0,0 +1,23 @@ +name: Pylint + +on: [push] + +jobs: + build: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ["3.8", "3.9", "3.10"] + steps: + - uses: actions/checkout@v4 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v3 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install pylint + - name: Analysing the code with pylint + run: | + pylint $(git ls-files '*.py')