Merge pull request #35 from HHS/dev

GCM Taskit v2.7.0 release
HHS · Feb 28, 2024 · 4875398 · 4875398
2 parents 0e99bd3 + e35532e
commit 4875398
Show file tree

Hide file tree

Showing 159 changed files with 935 additions and 1,322 deletions.
diff --git a/.github/workflows/dev_build.yml b/.github/workflows/dev_build.yml
@@ -30,8 +30,8 @@ jobs:
 
     - name: Get Taskit and GCM Versions
       run: |
-        echo "taskit_version=v$(mvn help:evaluate -Dexpression=taskit-protobuf.version -q -DforceStdout --file protobuf/pom.xml)" >> "$GITHUB_ENV"
-        echo "gcm_version=v$(mvn help:evaluate -Dexpression=gcm.version -q -DforceStdout --file protobuf/pom.xml)" >> "$GITHUB_ENV"
+        echo "taskit_version=v$(mvn help:evaluate -Dexpression=taskit.version -q -DforceStdout --file pom.xml)" >> "$GITHUB_ENV"
+        echo "gcm_version=v$(mvn help:evaluate -Dexpression=gcm.version -q -DforceStdout --file pom.xml)" >> "$GITHUB_ENV"
 
     - name: Checkout Taskit
       uses: actions/checkout@v4
@@ -48,7 +48,7 @@ jobs:
 
     - name: Get Util Version
       run: |
-        echo "util_version=v$(mvn help:evaluate -Dexpression=util.version -q -DforceStdout --file gcm/gcm/pom.xml)" >> "$GITHUB_ENV"
+        echo "util_version=v$(mvn help:evaluate -Dexpression=util.version -q -DforceStdout --file gcm/pom.xml)" >> "$GITHUB_ENV"
 
     - name: Checkout Util
       uses: actions/checkout@v4
@@ -60,11 +60,11 @@ jobs:
     - name: Build Util
       run: mvn clean install -DskipTests --file util/pom.xml
     - name: Build GCM
-      run: mvn clean install -DskipTests --file gcm/gcm/pom.xml
+      run: mvn clean install -DskipTests --file gcm/simulation/pom.xml
     - name: Build Taskit
       run: mvn clean install -DskipTests --file taskit/pom.xml
     - name: Build GCM Taskit
-      run: mvn clean install --file protobuf/pom.xml
+      run: mvn clean install --file pom.xml
 
     # Optional: Uploads the full dependency graph to GitHub to improve the quality of Dependabot alerts this repository can receive
    # - name: Update dependency graph

diff --git a/.github/workflows/release_build.yml b/.github/workflows/release_build.yml
@@ -31,8 +31,8 @@ jobs:
 
     - name: Get Taskit and GCM Versions
       run: |
-        echo "taskit_version=v$(mvn help:evaluate -Dexpression=taskit-protobuf.version -q -DforceStdout --file protobuf/pom.xml)" >> "$GITHUB_ENV"
-        echo "gcm_version=v$(mvn help:evaluate -Dexpression=gcm.version -q -DforceStdout --file protobuf/pom.xml)" >> "$GITHUB_ENV"
+        echo "taskit_version=v$(mvn help:evaluate -Dexpression=taskit.version -q -DforceStdout --file pom.xml)" >> "$GITHUB_ENV"
+        echo "gcm_version=v$(mvn help:evaluate -Dexpression=gcm.version -q -DforceStdout --file pom.xml)" >> "$GITHUB_ENV"
 
     - name: Checkout Taskit
       uses: actions/checkout@v4
@@ -49,7 +49,7 @@ jobs:
 
     - name: Get Util Version
       run: |
-        echo "util_version=v$(mvn help:evaluate -Dexpression=util.version -q -DforceStdout --file gcm/gcm/pom.xml)" >> "$GITHUB_ENV"
+        echo "util_version=v$(mvn help:evaluate -Dexpression=util.version -q -DforceStdout --file gcm/pom.xml)" >> "$GITHUB_ENV"
 
     - name: Checkout Util
       uses: actions/checkout@v4
@@ -61,19 +61,19 @@ jobs:
     - name: Build Util
       run: mvn clean install -DskipTests --file util/pom.xml
     - name: Build GCM
-      run: mvn clean install -DskipTests --file gcm/gcm/pom.xml
+      run: mvn clean install -DskipTests --file gcm/simulation/pom.xml
     - name: Build Taskit
       run: mvn clean install -DskipTests --file taskit/pom.xml
     - name: Build GCM Taskit
-      run: mvn clean install -Prelease --file protobuf/pom.xml
+      run: mvn clean install -Prelease --file pom.xml
 
     - name: Get Version
       run: |
-        echo "version=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout --file protobuf/pom.xml)" >> "$GITHUB_ENV"
+        echo "version=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout --file pom.xml)" >> "$GITHUB_ENV"
     - name: Make Release
       uses: ncipollo/release-action@v1
       with:
-        artifacts: "protobuf/target/gcm-taskit-protobuf-${{ env.version }}.jar,protobuf/target/gcm-taskit-protobuf-${{ env.version }}-sources.jar,protobuf/target/gcm-taskit-protobuf-${{ env.version }}-javadoc.jar"
+        artifacts: "protobuf/target/gcm-taskit-protobuf-${{ env.version }}*.jar"
         prerelease: ${{ endsWith(env.version, '-SNAPSHOT') || contains(env.version, '-RC') }}
         name: "v${{ env.version }}"
         tag: "v${{ env.version }}"

diff --git a/.github/workflows/release_pr_build.yml b/.github/workflows/release_pr_build.yml
@@ -29,8 +29,8 @@ jobs:
 
     - name: Get Taskit and GCM Versions
       run: |
-        echo "taskit_version=v$(mvn help:evaluate -Dexpression=taskit-protobuf.version -q -DforceStdout --file protobuf/pom.xml)" >> "$GITHUB_ENV"
-        echo "gcm_version=v$(mvn help:evaluate -Dexpression=gcm.version -q -DforceStdout --file protobuf/pom.xml)" >> "$GITHUB_ENV"
+        echo "taskit_version=v$(mvn help:evaluate -Dexpression=taskit.version -q -DforceStdout --file pom.xml)" >> "$GITHUB_ENV"
+        echo "gcm_version=v$(mvn help:evaluate -Dexpression=gcm.version -q -DforceStdout --file pom.xml)" >> "$GITHUB_ENV"
 
     - name: Checkout Taskit
       uses: actions/checkout@v4
@@ -47,7 +47,7 @@ jobs:
 
     - name: Get Util Version
       run: |
-        echo "util_version=v$(mvn help:evaluate -Dexpression=util.version -q -DforceStdout --file gcm/gcm/pom.xml)" >> "$GITHUB_ENV"
+        echo "util_version=v$(mvn help:evaluate -Dexpression=util.version -q -DforceStdout --file gcm/pom.xml)" >> "$GITHUB_ENV"
 
     - name: Checkout Util
       uses: actions/checkout@v4
@@ -59,8 +59,8 @@ jobs:
     - name: Build Util
       run: mvn clean install -DskipTests --file util/pom.xml
     - name: Build GCM
-      run: mvn clean install -DskipTests --file gcm/gcm/pom.xml
+      run: mvn clean install -DskipTests --file gcm/simulation/pom.xml
     - name: Build Taskit
       run: mvn clean install -DskipTests --file taskit/pom.xml
     - name: Build GCM Taskit
-      run: mvn clean install -Prelease --file protobuf/pom.xml
+      run: mvn clean install -Prelease --file pom.xml
diff --git a/README.md b/README.md
@@ -1,3 +1,41 @@
-GCM Taskit Implementation
+[![GPL LICENSE][license-shield]][license-url]
+[![GitHub tag (with filter)][tag-shield]][tag-url]
+[![GitHub contributors][contributors-shield]][contributors-url]
+[![GitHub Workflow Status (with event)][dev-build-shield]][dev-build-url]
+[![GitHub Workflow Status (with event)][build-shield]][build-url]
+
+# Translation And Serialization Toolkit (Taskit) for the General Computational Model (GCM)
+An implementation of [Taskit](https://github.com/HHS/ASPR-ms-taskit) for use with [GCM](https://github.com/HHS/ASPR-8).
+
+## Overview
+The only implementation of Taskit for GCM currently is Protobuf
+
+## Requirements
+- Maven 3.8.x
+- Java 17
+- Favorite IDE for Java development
+- Modeling Util located [here](https://github.com/HHS/ASPR-ms-util)
+- Taskit located [here](https://github.com/HHS/ASPR-ms-taskit)
+
+## Building
+To build, navigate into the root directory and run the command ```mvn clean install```
+
+## Documentation
+Documentation has yet to be created. In the interim, the code is mostly commented and the javadocs do provide good detail with regards to method and class expectations. 
+
+## License
+Distributed under the GPLv3 License. See [LICENSE](LICENSE) for more information.
+
+
+<!-- MARKDOWN LINKS & IMAGES -->
+[contributors-shield]: https://img.shields.io/github/contributors/HHS/ASPR-ms-gcm-taskit
+[contributors-url]: https://github.com/HHS/ASPR-ms-gcm-taskit/graphs/contributors
+[tag-shield]: https://img.shields.io/github/v/tag/HHS/ASPR-ms-gcm-taskit
+[tag-url]: https://github.com/HHS/ASPR-ms-gcm-taskit/releases/latest
+[license-shield]: https://img.shields.io/github/license/HHS/ASPR-ms-gcm-taskit
+[license-url]: LICENSE
+[dev-build-shield]: https://img.shields.io/github/actions/workflow/status/HHS/ASPR-ms-gcm-taskit/dev_build.yml?label=dev-build
+[dev-build-url]: https://github.com/HHS/ASPR-ms-gcm-taskit/actions/workflows/dev_build.yml
+[build-shield]: https://img.shields.io/github/actions/workflow/status/HHS/ASPR-ms-gcm-taskit/release_build.yml?label=release-build
+[build-url]: https://github.com/HHS/ASPR-ms-gcm-taskit/actions/workflows/release_build.yml.yml
 
-Implentation of taskit for gcm. Currently provides only a protobuf implementation but other implementations will follow in the future.