Updated namings and added release workflow. (#2)

* Updated namings and added release workflow.

* Updated lock file

* Updated upload artifact action to newest version

* Temporarily excluding combination of windows-latest and python3.13 due to runner segfault.

Author: sm00thix

.github/actions/build/action.yml

@@ -9,7 +9,7 @@ runs:
     - name: Set up Python
       uses: actions/setup-python@v3
       with:
-        python-version: '3.12'
+        python-version: '3.13'
 
     - name: Install dependencies
       run: |
@@ -40,7 +40,7 @@ runs:
       shell: bash
 
     - name: Store the distribution packages
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: python-package-distributions
         path: dist/

.github/actions/publish/action.yml

@@ -0,0 +1,43 @@
+name: Release
+description: Create a GitHub release
+
+runs:
+    using: "composite"
+    steps:
+      - name: Extract version from pyproject.toml
+        id: get_version
+        run: |
+          version=$(grep -o 'version = "[^"]*"' pyproject.toml | sed -E 's/version = "(.*)"/\1/')
+          echo "VERSION=$version" >> $GITHUB_ENV
+        shell: bash
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Sign the dists with Sigstore
+        uses: sigstore/gh-action-sigstore-python@v3.0.0
+        with:
+          inputs: >-
+            ./dist/*.tar.gz
+            ./dist/*.whl
+      - name: Create GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        run: >-
+          gh release create
+          "v${{ env.VERSION }}"
+          --repo "$GITHUB_REPOSITORY"
+          --notes ""
+        shell: bash
+      - name: Upload artifact signatures to GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        # Upload to GitHub Release using the `gh` CLI.
+        # `dist/` contains the built packages, and the
+        # sigstore-produced signatures and certificates.
+        run: >-
+          gh release upload
+          "v${{ env.VERSION }}" dist/**
+          --repo "$GITHUB_REPOSITORY"
+        shell: bash

.github/actions/release/action.yml

@@ -19,9 +19,23 @@ jobs:
         if: ${{ github.event.workflow_run.conclusion == 'success' }}
         steps:  
             - uses: actions/checkout@v4
-            - uses: ./.github/actions/publish
+            - uses: actions/download-artifact@v3
+              with:
+                name: python-package-distributions
+                path: dist/
+            - uses: pypa/gh-action-pypi-publish@release/v1
         permissions:
             id-token: write
         environment:
             name: pypi
-            url: https://pypi.org/p/ikpls
+            url: https://pypi.org/p/ikpls
+
+    github_release:
+        needs: publish_package
+        runs-on: ubuntu-latest
+        permissions:
+            contents: write
+            id-token: write
+        steps:
+            - uses: actions/checkout@v4
+            - uses: ./.github/actions/release

.github/workflows/package_workflow.yml

@@ -17,7 +17,10 @@ jobs:
       fail-fast: false  
       matrix:  
         os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: ["3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        exclude:
+          - os: windows-latest
+            python-version: "3.13"
     steps:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/test

.github/workflows/pull_request_test_workflow.yml

@@ -17,7 +17,10 @@ jobs:
             fail-fast: false  
             matrix:  
                 os: [ubuntu-latest, windows-latest, macos-latest]
-                python-version: ["3.9", "3.10", "3.11", "3.12"]
+                python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+                exclude:
+                    - os: windows-latest
+                      python-version: "3.13"
         steps:
             - uses: actions/checkout@v4
             - uses: ./.github/actions/test

.github/workflows/test_workflow.yml

@@ -44,11 +44,11 @@ For an implementation of the fast cross-validation algorithms combined with Impr
 >
 > X = np.random.uniform(size=(N, K)) # Random X data
 > Y = np.random.uniform(size=(N, M)) # Random Y data
-> cv_splits = np.arange(100) % 5 # 5-fold cross-validation
+> folds = np.arange(100) % 5 # 5-fold cross-validation
 >
 > # Instantiate CVMatrix
 > cvm = CVMatrix(
->     cv_splits=cv_splits,
+>     folds=folds,
 >     center_X=True,
 >     center_Y=True,
 >     scale_X=True,
@@ -57,13 +57,13 @@ For an implementation of the fast cross-validation algorithms combined with Impr
 > # Fit on X and Y
 > cvm.fit(X=X, Y=Y)
 > # Compute training set XTX and/or XTY for each fold
-> for val_split in cvm.val_folds_dict.keys():
+> for fold in cvm.folds_dict.keys():
 >     # Get both XTX and XTY
->     training_XTX, training_XTY = cvm.training_XTX_XTY(val_split)
+>     training_XTX, training_XTY = cvm.training_XTX_XTY(fold)
 >     # Get only XTX
->     training_XTX = cvm.training_XTX(val_split)
+>     training_XTX = cvm.training_XTX(fold)
 >     # Get only XTY
->     training_XTY = cvm.training_XTY(val_split)
+>     training_XTY = cvm.training_XTY(fold)
 
 ### Examples
 In [examples](https://github.com/Sm00thix/CVMatrix/tree/main/examples), you will find: