Merge pull request #3 from oqc-community/bgs/release-ready

Updated README.md, CODEOWNERS and workflows

.github/CODEOWNERS

@@ -1 +1,3 @@
-* @keriksson-rosenqvist @owen-oqc @hamidelmaazouz @bgsach
+# For now everyone gets added to all PRs by default. Fine while the PR velocity is small, we'll change if
+# necessary as time goes on.
+* @keriksson-rosenqvist @owen-oqc @hamidelmaazouz @bgsach @daria-oqc @lcauser-oqc @alillistone-OQC

.github/workflows/package-publish.yml

@@ -2,14 +2,34 @@ name: Publish package to PyPI and TestPyPI
 
 on:
   push:
-    branches: [ main ]
     tags: [ '[0-9]+.[0-9]+.[0-9]+' ]
-
 jobs:
+  check-current-branch:
+    runs-on: ubuntu-latest
+    outputs:
+      branch: ${{ steps.check_step.outputs.branch }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Get current branch
+        id: check_step
+        # 1. Get the list of branches ref where this tag exists
+        # 2. Remove 'origin/' from that result
+        # 3. Put that string in output
+        # => We can now use function 'contains(list, item)''
+        run: |
+          raw=$(git branch -r --contains ${{ github.ref }})
+          branch="$(echo ${raw//origin\//} | tr -d '\n')"
+          echo "{name}=branch" >> $GITHUB_OUTPUT
+          echo "Branches where this tag exists : $branch."          
   build:
     name: Build
     runs-on: ubuntu-latest
-
+    needs: check-current-branch
+    # only run if tag is present on branch 'main'
+    if: contains(${{ needs.check-current-branch.outputs.branch }}, 'main')`
     steps:
     - uses: actions/checkout@v4
 
@@ -20,6 +40,11 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version: "3.x"
+    - name: Check poetry version matches tag
+      run: | 
+        POETRY_VERSION=$(poetry version -s)
+        TAG=$(echo $GITHUB_REF | cut -d / -f 3)
+        [ $POETRY_VERSION = $TAG ] 
     - name: Poetry install
       run: poetry install --sync
 

.github/workflows/package-tests.yml

@@ -2,7 +2,7 @@ name: Build
 
 on:
   pull_request:
-    branches: [main, develop]
+    branches: [main]
   workflow_dispatch:
 
 permissions:

README.md

@@ -1,2 +1,9 @@
-# comiler-config
-OQC's compiler configuration
+# compiler-config
+
+OQC's task level compiler configuration. The compiler-config package is an internal dependency of [QAT](https://github.com/oqc-community/qat) 
+(OQC's compiler and runtime) and will soon be adopted as a dependency of our QCaaS (Quantum Computing as a Service) client. *End users should not need to interact with this package except via QAT or QCAAS client.*
+
+#### Licence
+
+This code in this repository is licensed under the BSD 3-Clause Licence.
+Please see [LICENSE](LICENSE) for more information.

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "compiler-config"
-version = "1.0.0"
+version = "0.1.0"
 description = ""
 authors = ["jamie <[email protected]>"]
 readme = "README.md"