psdi-data-conversion 0.0.30__tar.gz → 0.0.32__tar.gz

psdi_data_conversion-0.0.32/.github/workflows/ci-deploy-production.yml

@@ -0,0 +1,61 @@
+# Workflow for manually triggering deployment of latest release version to the production environment
+
+# It is intended that this workflow be manually triggered after the 'ci-release.yml' job has been shown
+# to successfully deploy the latest release version to the staging cluster.
+
+# To be more specific, this workflow deploys the container in the GitHub Container Registry namespace for this
+# repo whose tag corresponds to the highest version number, while only considering tags of the form 'v*.*.*',
+# where '*' signify non-negative integers.
+
+name: CI - Deploy to production cluster
+run-name: CI - Deploy to production cluster
+on:
+  workflow_dispatch:
+
+jobs:
+  check-branch:
+    # Check that this job is being run on the release branch
+    runs-on: psdi-uk-runners
+    steps:
+      - name: Check branch (success)
+        if: github.ref == 'refs/heads/release'
+        run: echo "Success - this is being run on the 'release' branch"
+      - name: Check branch (failure)
+        if: github.ref != 'refs/heads/release'
+        run: |
+          echo "ERROR: This workflow can only be run on the 'release' branch"
+          false # Command that always fails, to signal the job to fail
+
+  get-latest-release-tag:
+    # run on our self hosted github runners enabling access to STFC infrastructure
+    runs-on: psdi-uk-runners
+    needs: check-branch
+    outputs:
+      tag: ${{ steps.get-tag.outputs.TARGET_TAG }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Get latest tag in the relase branch
+        id: get-tag
+        run: |
+          # Use GitHub CR API to get list of all tags
+          GHCR_TOKEN=$(echo -n "${{ secrets.GITHUB_TOKEN }}" | base64 -w 0)
+          echo "Requesting list of tags from GitHub CR for repo..."
+          RESPONSE=$(curl -s -H "Authorization: Bearer $GHCR_TOKEN" "https://ghcr.io/v2/psdi-uk/psdi-data-conversion/data-conversion/tags/list")
+          echo "Response recieved = $RESPONSE"
+          # Extract only the tags corresponding to releases, i.e. of the form 'v*.*.*'
+          echo "Extracting tags from response..."
+          TAGS=$(echo "$RESPONSE" | jq -r '."tags"[]' | grep -E '^v[0-9]+\.[0-9]+\.[0-9]+')
+          echo "Extracted tags = $TAGS"
+          # Find the highest version number
+          TARGET_TAG=$(echo "$TAGS" | sort -V | tail -n 1)
+          echo "TARGET_TAG=$TARGET_TAG" >> "$GITHUB_OUTPUT"
+          echo "Highest version tag found to be = $TARGET_TAG"
+
+  # Deploy container with tag to production environment
+  deploy-stfc-production-k8s:
+    needs: get-latest-release-tag
+    uses: ./.github/workflows/job-deploy-k8s.yml # use the callable deploy job
+    secrets: inherit # pass all secrets for the environment
+    with:
+      container_tag: ${{ needs.get-latest-release-tag.outputs.tag }}
+      environment: production

{psdi_data_conversion-0.0.30 → psdi_data_conversion-0.0.32}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: psdi_data_conversion
-Version: 0.0.30
+Version: 0.0.32
 Summary: Chemistry file format conversion service, provided by PSDI
 Project-URL: Homepage, https://psdidev2.azurewebsites.net/
 Project-URL: Documentation, https://psdi-uk.github.io/psdi-data-conversion/
@@ -278,6 +278,9 @@ This is the repository for the PSDI PF2 Chemistry File Format Conversion project
   - [Installation and Setup](#installation-and-setup)
   - [Running the App](#running-the-app)
 - [Testing](#testing)
+- [Licencing](#licencing)
+- [Contributors](#contributors)
+- [Funding](#funding)
 
 ## Project Structure
 
@@ -650,6 +653,21 @@ cd tests/selenium
 kill %1 # Stop the web server - it may have a different job ID. If you don't know the job ID, you can alternatively call "fg" to bring the job to the foreground, then type CTRL+c to stop it
 ```
 
+## Licencing
+
+This project is provided under the Apache License version 2.0, the terms of which can be found in the file `LICENSE`.
+
+This project redistributes compiled binaries for the Atomsk and c2x converters. These are both licenced under the
+GNU General Public License version 3 and are redistributed per its terms. Any further redistribution of these binaries,
+including redistribution of this project as a whole, including them, must also follow the terms of this licence.
+
+This requires conspicuously displaying notice of this licence, providing the text of of the licence (provided here in
+the files `psdi_data_conversion/bin/LICENSE_C2X` and `psdi_data_conversion/bin/LICENSE_ATOMSK`), and appropriately
+conveying the source code for each of these. Their respective source code may be found at:
+
+- Atomsk: https://github.com/pierrehirel/atomsk/
+- c2x: https://www.c2x.org.uk/downloads/
+
 ## Contributors
 
 - Ray Whorley

{psdi_data_conversion-0.0.30 → psdi_data_conversion-0.0.32}/README.md

@@ -33,6 +33,9 @@ This is the repository for the PSDI PF2 Chemistry File Format Conversion project
   - [Installation and Setup](#installation-and-setup)
   - [Running the App](#running-the-app)
 - [Testing](#testing)
+- [Licencing](#licencing)
+- [Contributors](#contributors)
+- [Funding](#funding)
 
 ## Project Structure
 
@@ -405,6 +408,21 @@ cd tests/selenium
 kill %1 # Stop the web server - it may have a different job ID. If you don't know the job ID, you can alternatively call "fg" to bring the job to the foreground, then type CTRL+c to stop it
 ```
 
+## Licencing
+
+This project is provided under the Apache License version 2.0, the terms of which can be found in the file `LICENSE`.
+
+This project redistributes compiled binaries for the Atomsk and c2x converters. These are both licenced under the
+GNU General Public License version 3 and are redistributed per its terms. Any further redistribution of these binaries,
+including redistribution of this project as a whole, including them, must also follow the terms of this licence.
+
+This requires conspicuously displaying notice of this licence, providing the text of of the licence (provided here in
+the files `psdi_data_conversion/bin/LICENSE_C2X` and `psdi_data_conversion/bin/LICENSE_ATOMSK`), and appropriately
+conveying the source code for each of these. Their respective source code may be found at:
+
+- Atomsk: https://github.com/pierrehirel/atomsk/
+- c2x: https://www.c2x.org.uk/downloads/
+
 ## Contributors
 
 - Ray Whorley