Merge pull request #101 from dmgav/ci_configuration

CI configuration

.github/workflows/docs.yml

@@ -19,7 +19,12 @@ jobs:
     - name: Install dependencies
       run: |
         sudo apt install redis
-        python -m pip install --upgrade pip
+
+        # These packages are installed in the base environment but may be older
+        # versions. Explicitly upgrade them because they often create
+        # installation problems if out of date.
+        python -m pip install --upgrade pip setuptools numpy
+
         pip install .
         pip install -r requirements-dev.txt
         pip list

.github/workflows/docs_publish.yml

@@ -7,8 +7,7 @@ on:
 
 jobs:
   build:
-
-    if: github.repository == 'bluesky/bluesky-queueserver'
+    if: github.repository_owner == 'bluesky'
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -23,16 +22,27 @@ jobs:
     - name: Install dependencies
       run: |
         sudo apt install redis
-        python -m pip install --upgrade pip
+
+        # These packages are installed in the base environment but may be older
+        # versions. Explicitly upgrade them because they often create
+        # installation problems if out of date.
+        python -m pip install --upgrade pip setuptools numpy
+
         pip install .
         pip install -r requirements-dev.txt
         pip list
     - name: Build Docs
       run: |
         make -C docs/ html
-    - name: Deploy Docs
-      env:
-        BUILD_DIR: "docs/build/html"
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      run: |
-        ./.github/workflows/deploy_docs.sh
+    - name: Deploy documentation to blueskyproject.io
+      # We pin to the SHA, not the tag, for security reasons.
+      # https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
+      uses: peaceiris/actions-gh-pages@bbdfb200618d235585ad98e965f4aafc39b4c501  # v3.7.3
+      with:
+        deploy_key: ${{ secrets.ACTIONS_DOCUMENTATION_DEPLOY_KEY }}
+        publish_branch: main
+        publish_dir: ./docs/build/html
+        external_repository: bluesky/bluesky.github.io
+        destination_dir: bluesky-queueserver
+        keep_files: true  # Keep old files.
+        force_orphan: false  # Keep git history.

.github/workflows/flake8.yml

@@ -10,7 +10,11 @@ jobs:
       - uses: actions/setup-python@v2
       - name: Install Dependencies
         run: |
-          python -m pip install --upgrade pip
+          # These packages are installed in the base environment but may be older
+          # versions. Explicitly upgrade them because they often create
+          # installation problems if out of date.
+          python -m pip install --upgrade pip setuptools numpy
+
           pip install flake8
       - name: Run flake8
         run: |

.github/workflows/testing.yml

@@ -19,11 +19,14 @@ jobs:
     - name: Install dependencies
       run: |
         sudo apt install redis
-        python -m pip install --upgrade pip
+
+        # These packages are installed in the base environment but may be older
+        # versions. Explicitly upgrade them because they often create
+        # installation problems if out of date.
+        python -m pip install --upgrade pip setuptools numpy
+
         pip install .
         pip install -r requirements-dev.txt
-        pip install scikit-image
-        pip install pytest
         pip list
     - name: Test with pytest
       run: |

README.rst

@@ -2,9 +2,6 @@
 bluesky-queueserver
 ===================
 
-.. image:: https://img.shields.io/travis/bluesky/bluesky-queueserver.svg
-        :target: https://travis-ci.org/bluesky/bluesky-queueserver
-
 .. image:: https://img.shields.io/pypi/v/bluesky-queueserver.svg
         :target: https://pypi.python.org/pypi/bluesky-queueserver
 

requirements-dev.txt

@@ -11,6 +11,7 @@ sphinx
 ipython
 matplotlib
 numpydoc
+scikit-image
 sphinx-copybutton
 sphinx_rtd_theme
 # Extra dependencies for development