Merge pull request #107 from fangohr/add-diff-ci

Add CI to diff with upstream package

.github/workflows/diff-with-upstream.yml

@@ -0,0 +1,17 @@
+name: diff-with-upstream
+
+on:
+  schedule:
+    - cron: "0 0 * * 0" # Run once a week on Sunday at midnight
+  workflow_dispatch:
+
+jobs:
+
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Fetch and compare with upstream spack Octopus package file
+      run: make diff

Makefile

@@ -26,4 +26,4 @@ run-spack:
 diff:
 	@echo "Compare (diff) spack/package.py with current package.py from spack develop"
 	wget --output-document=spack/package-upstream.py https://raw.githubusercontent.com/spack/spack/develop/var/spack/repos/builtin/packages/octopus/package.py
-	diff spack/package-upstream.py spack/package.py || true
+	diff spack/package-upstream.py spack/package.py

README.rst

@@ -6,7 +6,7 @@ Octopus in spack
 
 .. sectnum::
 
-.. contents:: 
+.. contents::
 
 Octopus-in-spack
 ================
@@ -31,6 +31,8 @@ moment (if you follow `Compilation of Octopus using Spack`_):
 
 |spack-develop-octopus-develop| Spack develop version, develop version of Octopus
 
+|diff-with-upstream| A check to see if our `octopus/package.py` file is in sync with the upstream [spack repository](https://github.com/spack/spack/blob/develop/var/spack/repos/builtin/packages/octopus/package.py).
+
 
 Octopus and Spack - Quick start
 ===============================
@@ -94,6 +96,8 @@ https://github.com/fangohr/octopus-in-docker
 .. |spack-develop-octopus-develop| image:: https://github.com/fangohr/octopus-in-spack/actions/workflows/spack-develop-octopus-develop.yml/badge.svg
    :target: https://github.com/fangohr/octopus-in-spack/actions/workflows/spack-develop-octopus-develop.yml
 
+.. |diff-with-upstream| image:: https://github.com/fangohr/octopus-in-spack/actions/workflows/diff-with-upstream.yml/badge.svg
+   :target: https://github.com/fangohr/octopus-in-spack/actions/workflows/sdiff-with-upstream.yml
 
 .. comment: Outdated badges to follow