cleaning up github actions

Author: dschwartz-ftadvisory

.github/workflows/build-and-test-develop.yml

@@ -0,0 +1,11 @@
+name: Build and Test JAR
+
+on:
+  push:
+    branches: [ "develop" ]
+  pull_request:
+    branches: [ "develop" ]
+
+jobs:
+  build_and_test:
+    uses: ./.github/workflows/build-and-test.yml

.github/workflows/build-and-test-main.yml

@@ -1,11 +1,3 @@
-# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-maven
-
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-
 name: Build and Test JAR
 
 on:
@@ -16,26 +8,4 @@ on:
 
 jobs:
   build_and_test:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v4
-    - name: Set up JDK 21
-      uses: actions/setup-java@v4
-      with:
-        java-version: '21'
-        distribution: 'temurin'
-        cache: maven
-    - name: Set up Python 3.11
-      uses: actions/setup-python@v4
-      with:
-        python-version: '3.11'
-    - name: Build with Maven
-      run: mvn -B package -Psign-artifacts --file pom.xml
-    - name: Run Python Unit Tests
-      run: |
-        chmod +x build/setup_python_env.sh
-        chmod +x test/python_unit_tests/setup_unit_test_env.sh
-        chmod +x test/python_unit_tests/run_python_unit_tests.sh
-        test/python_unit_tests/run_python_unit_tests.sh
+    uses: ./.github/workflows/build-and-test.yml

.github/workflows/build-and-test.yml

@@ -0,0 +1,29 @@
+name: Build and Test (Reusable)
+
+on:
+  workflow_call:
+
+jobs:
+  build_and_test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4
+        with:
+          java-version: '21'
+          distribution: 'temurin'
+          cache: maven
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+      - name: Build with Maven
+        run: mvn -B package -Psign-artifacts --file pom.xml
+      - name: Run Python Unit Tests
+        run: |
+          chmod +x test/python_setup/setup_python_env.sh
+          chmod +x test/python_setup/cleanup_python_env.sh
+          chmod +x test/python_unit_tests/setup_unit_test_env.sh
+          chmod +x test/python_unit_tests/run_python_unit_tests.sh
+          test/python_unit_tests/run_python_unit_tests.sh

.github/workflows/renovate.yml

@@ -12,28 +12,25 @@ on:
 jobs:
   renovate:
     runs-on: ubuntu-latest
-    # This section is crucial. It grants the GITHUB_TOKEN the necessary
-    # permissions for Renovate to read repository content and create pull requests.
+    # Grants the GITHUB_TOKEN the necessary permissions for Renovate to read repository content and create pull requests.
     permissions:
       contents: write
       pull-requests: write
     steps:
-      # Checks out your repository under $GITHUB_WORKSPACE, so your job can access it
+      # Checks out the repository under $GITHUB_WORKSPACE, so your job can access it
       - uses: actions/checkout@v4
-
       # Runs the Renovate GitHub Action
       - name: Renovate
         # Using a slightly newer version of the action
         uses: renovatebot/[email protected]
         with:
           # The token is required to create pull requests.
-          # GITHUB_TOKEN is automatically created by Actions and is given
-          # the permissions defined in the `permissions` block above.
           token: ${{ secrets.GITHUB_TOKEN }}
           # Specifies the path to your Renovate configuration file.
           configurationFile: .github/renovate.json
         env:
-          # Use 'debug' for verbose logging, which is helpful for troubleshooting.
-          LOG_LEVEL: 'debug'
           RENOVATE_REPOSITORIES: ${{ github.repository }} # This tells Renovate to scan the current repo
-
+  # Add a build and test job that depends on renovate
+  build_and_test:
+    needs: renovate
+    uses: ./.github/workflows/build-and-test.yml

README.md

@@ -37,7 +37,7 @@ Start by cloning the project: `git clone https://github.com/finos/rune-python-ge
 
 Our project runs with Java 21. Make sure that your Maven also uses this version of Java by running `mvn -v`.
 
-To build the project, run `mvn clean install`.
+To build the project, run `mvn clean package`.
 
 #### UNIT Testing
 Building the project using Maven will run JUNIT-based unit tests.  All tests should pass.  To run the Python unit tests follow the instructions in [BUILDANDTEST.md](./BUILDANDTEST.md)
@@ -55,11 +55,18 @@ We use [Checkstyle](https://checkstyle.sourceforge.io/) for enforcing good codin
 #### Open the project in Eclipse
 Go to Import... > Existing Maven Project, select the right folder, click Finish.
 
+### Standalone CLI
+The generator includes a standalone CLI which can be invoked to generate Python from a single file or from directory.  To invoke the CLI, first build the project and then:
+
+```sh
+java -cp target/python-0.0.0.main-SNAPSHOT.jar com.regnosys.rosetta.generator.python.PythonCodeGeneratorCLI
+```
+
 ### To Generate CDM from Rune
 
 Use this script to generated the Python version of CDM
 ```sh
-build/build_cdm.sh
+test/cdm_tests/cdm_setup/build_cdm.sh
 ```
 The script will use the CDM from the branch specified in the file (E.G. master) of the [FINOS Repo](https://github.com/finos/common-domain-model) and generate a wheel in the project directory `target/python-cdm`
 
@@ -69,6 +76,14 @@ To use a different version of CDM, update CDM_VERSION in the script.
 
 The Roadmap will be aligned to the [Rune-DSL](https://github.com/finos/rune-dsl/) and [CDM](https://github.com/finos/common-domain-model/blob/master/ROADMAP.md) roadmaps.
 
+### Rune-DSL Updates
+
+Renovate will generate a PR when the version of the DSL has been updated at com.regnosys.rosetta:com.regnosys.rosetta.  The PR will calrify whether the change succsessfully builds and passes JUNIT and Python unit testing.
+
+Any maintainer can merge changes that successfully build and pass the tests.
+
+Build or testing failures should be escalated to [@plamen-neykov](https://github.com/plamen-neykov) or [@dschwartznyc](https://github.com/dschwartznyc) for remediation.
+
 ## Contributing
 For any questions, bugs or feature requests please open an [issue](https://github.com/finos/rune-python-generator/issues)
 For anything else please send an email to {project mailing list}.
@@ -81,9 +96,11 @@ To submit a contribution:
 5. Push to the branch (`git push origin feature/fooBar`)
 6. Create a new Pull Request
 
-_NOTE:_ Commits and pull requests to FINOS repositories will only be accepted from those contributors with an active, executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active Corporate Contribution License Agreement (CCLA) executed with FINOS. Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS Clabot tool (or EasyCLA). Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA.
+_NOTE:_ Commits and pull requests to FINOS repositories will only be accepted from those contributors with an active, executed Individual Contributor License Agreement (ICLA) with FINOS OR
+who are covered under an existing and active Corporate Contribution License Agreement (CCLA) executed with FINOS. Commits from individuals not covered under an ICLA or CCLA will be flagged
+and blocked by the FINOS Clabot tool (or EasyCLA). Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA.
 
-Unsure if you are covered under an existing CCLA? Email [email protected]*
+If you are unsure if you are covered under an existing CCLA send an email to [email protected]
 
 ## Get in touch with the Rune Python Generator Team