#3 Added aiSSEMBLE GitHub Action release job #332

jacksondelametter · 2024-09-12T20:20:10Z

This is a PR to add the aiSSEMBLE GitHub Action release job. This action mimics the Jenkins release job found here https://github.boozallencsn.com/aissemble/aissemble/blob/fix-ci/devops/JenkinsfileRelease.groovy

The release job aims to do the following

Parses the inputted version to get its major, minor, and patch counterparts
Executes a pre release update to the release branch's Antora documentation
Cuts a release of the release branch
Executes a post release update to the release branch's Antora documentation

jacksondelametter · 2024-09-12T21:07:01Z

.github/workflows/release.yml

+
+    runs-on: arc-runner-set-aissemble
+    env:
+      DOCKER_CONFIG: /home/runner/.docker


Using env variables to easily switch out using workflow_dispatch input values and hardcoded values for testing!

jacksondelametter · 2024-09-12T21:07:25Z

.github/workflows/release.yml

+        description: "OPTIONAL: The existing aiSSEMBLE version. Defaults to patchVersion-SNAPSHOT"
+        required: false
+        type: string
+      dryRun:


Allows us to toggle running the release job in dryRun mode.

aaron-gary

Looks good to me, but I haven't done a release on aiSSEMBLE so be sure you get a second opinion from baseline.

Also, be sure to sign all commits.

.github/workflows/release.yml

carter-cundiff · 2024-09-13T13:14:42Z

.github/workflows/release.yml

+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - uses: actions/checkout@v4


Q: - uses: actions/checkout@v4 this is used twice, is that needed? Also on line 106.

Yes it is needed, it is a bug with using custom actions. You have to checkout the current branch your running on for them to show up. The other checkout checks out the release branch.

Recommend grouping them together (if possible) and leaving a comment explaining that.

I cant group them unfortunately but I can leave a comment

I don't think you'll need a double checkout once this is merged to dev. Do you have a link to the info you found saying you would need that?

Ok this is actually not a bug. It looks like if you dont do a initial checkout, the local aissemble repository is actually not present in the runner. By doing an initial checkout, the repository is present and the branch being ran on is checked out.

carter-cundiff · 2024-09-13T13:26:58Z

.github/actions/split_version/action.yaml

+    description: 'Existing version'
+    required: true
+outputs:
+  minor-version:


S: Would update this variable to be major-minor-version, sort of misleading currently.

carter-cundiff · 2024-09-13T13:30:08Z

.github/actions/split_version/action.yaml

+    description: "Is pre-release version"
+    value: ${{ steps.split.outputs.release-branch }}
+  existing-version:
+    description: "Is pre-release version"


S: Update descriptions

carter-cundiff · 2024-09-13T13:32:11Z

.github/actions/split_version/action.yaml

+        echo "minor-version=$minor_version" >> $GITHUB_OUTPUT 
+        echo "patch-version=$patch_version" >> $GITHUB_OUTPUT
+        echo "is-pre-release=$( [ "${{ inputs.version }}" != "$patch_version" ] && echo true || echo false)" >> $GITHUB_OUTPUT
+        echo "release-branch=$( [ "${{ inputs.releaseBranch }}" != "" ] && echo "${{ inputs.releaseBranch }}" || echo "aissemble-release-$minor_version")" >> $GITHUB_OUTPUT


Q: Have you verified this works having the echo and part of the && conditional?

Yes this works!

carter-cundiff · 2024-09-13T13:38:32Z

.github/workflows/release.yml

+          custom-facet-new-version: ${{ env.RELEASE_VERSION }}
+      - name: Create settings.xml
+        run: |
+          echo "<settings><servers><server><id>ossrh</id><username>${{ secrets.SONATYPE_CENTRAL_REPO_TOKEN_USER }}</username><password>${{ secrets.SONATYPE_CENTRAL_REPO_TOKEN_KEY }}</password></server><server><id>ghcr.io</id><username>${{ secrets.GHCR_IO_USERNAME }}</username><password>${{ secrets.GHCR_IO_TOKEN }}</password></server><server><id>pypi</id><username>${{ secrets.PYPI_USERNAME }}</username><password>${{ secrets.PYPI_TOKEN }}</password></server><server><id>dev-pypi</id><username>${{ secrets.TEST_PYPI_USERNAME }}</username><password>${{ secrets.TEST_PYPI_TOKEN }}</password></server> </servers></settings>" > $HOME/.m2/settings.xml


Q: Should we be using a differ pypi server for the release? I believe test pypi is only for our snapshots.

Its being uploaded to Pypi not test pypi, I verified this. We add in credentials to Pypi and test Pypi

Safe to remove this then? <id>dev-pypi</id><username>${{ secrets.TEST_PYPI_USERNAME }}</username><password>${{ secrets.TEST_PYPI_TOKEN }}</password>?

I am not sure if it is safe to remove!

yes it should be

carter-cundiff · 2024-09-13T13:53:39Z

.github/actions/split_version/action.yaml

+        minor=$(echo ${{ inputs.version }} | cut -d "." -f 2) 
+        patch=$(echo ${{ inputs.version }} | cut -d "." -f 3 | cut -d "-" -f 1)  
+        minor_version=$major.$minor
+        patch_version=$major.$minor.$patch


A: Would be helpful to have comments explaining what these vars are given inputs, for example from the old release script:

//grab second group (first embedded capture) in first match: 1.4.2-rc.3 -> 1.4.2 //grab second group (first embedded capture) in first match: 1.4.2 -> 1.4

Added comments to better explain

carter-cundiff · 2024-09-13T13:59:31Z

.github/workflows/release.yml

+        run: | 
+          echo "Releasing with the following parameters"
+          echo "Release version: ${{ env.RELEASE_VERSION }}"
+          echo "Development version: ${{ env.DEVELOPMENT_VERSION }}"


Optional: Change Development version -> Next Development Version and env.DEVELOPMENT_VERSION -> env.NEXT_DEVELOPMENT_VERSION

carter-cundiff · 2024-09-13T14:21:57Z

.github/workflows/release.yml

+        default: false
+        type: boolean
+  push:
+    branches: [ "3-add-release" ]


This will be removed before merge? Does it need a different value?

C: This needs to be removed before merging. This workflow should be on dispatch only.

Yes, this is only for testing purposes. It will be removed before being merged.

ewilkins-csi · 2024-09-13T15:16:30Z

.github/actions/split_version/action.yaml

+    description: "Is pre-release version"
+    value: ${{ steps.split.outputs.is-pre-release }}
+  release-branch:
+    description: "Is pre-release version"


A: Update description

Removed descriptions

ewilkins-csi · 2024-09-13T15:17:01Z

.github/actions/split_version/action.yaml

+    required: true
+outputs:
+  major-minor-version:
+    description: "Major-minor version"


S: In general these descriptions are just restating the name of the output which doesn't seem helpful. We should either make them more explanatory or just omit them if we can.

Removed descriptions

ewilkins-csi · 2024-09-13T15:26:30Z

.github/actions/update_antora/action.yaml

+  release-branch:  
+    description: 'Release branch'
+    required: true
+  custom-facet-old-version:  


Q: Why are these inputs instead of just being derived from version?

When updating the custom facet schemas, what we change differs between the pre release Antora docs update and the post release.

ewilkins-csi · 2024-09-13T15:27:44Z

.github/actions/update_antora/action.yaml

+        git config --global user.name "aiSSEMBLE Team"
+        git diff
+        git add .
+        git commit -S -m "Updating scripts and templates to ${{ inputs.version }}"


A: I'd make the commit message more accurate. This is likely a carryover from when we updated more stuff manually instead of through the build process.

Changed to "Updating Antora documentation to version ..."

ewilkins-csi · 2024-09-13T15:31:42Z

.github/workflows/release.yml

+      NEXT_DEVELOPMENT_VERSION: ${{ inputs.developmentVersion || '1.10.0-SNAPSHOT' }}
+      RELEASE_BRANCH: ${{ inputs.releaseBranch }}
+      EXISTING_VERSION: ${{ inputs.existingVersion }}
+      DRY_RUN: ${{ inputs.dryRun || true }}


C: We should not be including these defaults at all. It just introduces risk/confusion. If this script is updated/worked on in the future and such mechanisms are helpful, the author can add this stuff in. However, I would argue that we should be testing by filling in the parameters manually anyway.

This is only for testing purposes. This will be deleted before being merged.

ewilkins-csi · 2024-09-13T15:35:23Z

.github/workflows/release.yml

+          curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3
+          chmod 700 get_helm.sh
+          ./get_helm.sh
+      - name: Install Helm Unittest Plugin


S: This is just a copy of what we're doing in build.yaml right? Strongly suggest we pull these out into a common place if so. We're already introducing the complexity of composite actions, and this is the core use case for them.

Added instal dependencies composite action.

ewilkins-csi · 2024-09-13T15:39:02Z

.github/workflows/release.yml

+          echo "<settings><servers><server><id>ossrh</id><username>${{ secrets.SONATYPE_CENTRAL_REPO_TOKEN_USER }}</username><password>${{ secrets.SONATYPE_CENTRAL_REPO_TOKEN_KEY }}</password></server><server><id>ghcr.io</id><username>${{ secrets.GHCR_IO_USERNAME }}</username><password>${{ secrets.GHCR_IO_TOKEN }}</password></server><server><id>pypi</id><username>${{ secrets.PYPI_USERNAME }}</username><password>${{ secrets.PYPI_TOKEN }}</password></server><server><id>dev-pypi</id><username>${{ secrets.TEST_PYPI_USERNAME }}</username><password>${{ secrets.TEST_PYPI_TOKEN }}</password></server> </servers></settings>" > $HOME/.m2/settings.xml
+      - name: Release aiSSEMBLE
+        run: | 
+          ./mvnw release:clean release:prepare release:perform -s $HOME/.m2/settings.xml -U -B -Pci,gh-build -DdryRun=${{ env.DRY_RUN }} -DpushChanges=true -DreleaseVersion=${{ env.RELEASE_VERSION }} -DdevelopmentVersion=${{ env.NEXT_DEVELOPMENT_VERSION }} [email protected] -DsignTag=true -Dmaven.build.cache.enabled=false


S: IMO the dry-run isn't going to be used enough to warrant having it checked in to dev and it just adds noise to the parameters. Esp since we aren't using it for things like the git commits at earlier steps.

- Update documentation to live under supporting components - #219 improve manual action message keys

jacksondelametter force-pushed the 3-add-release branch from 3138cff to 362fe93 Compare September 12, 2024 20:22

jacksondelametter commented Sep 12, 2024

View reviewed changes

aaron-gary approved these changes Sep 12, 2024

View reviewed changes

jacksondelametter force-pushed the 3-add-release branch from 362fe93 to 66651af Compare September 13, 2024 13:11

carter-cundiff reviewed Sep 13, 2024

View reviewed changes

.github/workflows/release.yml Outdated Show resolved Hide resolved

carter-cundiff reviewed Sep 13, 2024

View reviewed changes

jacksondelametter force-pushed the 3-add-release branch from 66651af to 17f4ce4 Compare September 13, 2024 13:25

carter-cundiff reviewed Sep 13, 2024

View reviewed changes

jacksondelametter force-pushed the 3-add-release branch from 17f4ce4 to fd43a8e Compare September 13, 2024 13:28

carter-cundiff reviewed Sep 13, 2024

View reviewed changes

jacksondelametter force-pushed the 3-add-release branch from fd43a8e to e5917fd Compare September 13, 2024 13:32

carter-cundiff reviewed Sep 13, 2024

View reviewed changes

jacksondelametter force-pushed the 3-add-release branch 2 times, most recently from 98aae12 to 0b93383 Compare September 13, 2024 14:21

carter-cundiff reviewed Sep 13, 2024

View reviewed changes

jacksondelametter force-pushed the 3-add-release branch 2 times, most recently from 7866381 to d7eb15d Compare September 13, 2024 15:15

ewilkins-csi reviewed Sep 13, 2024

View reviewed changes

jacksondelametter force-pushed the 3-add-release branch from d7eb15d to 48cd4f7 Compare September 13, 2024 15:51

carter-cundiff added a commit that referenced this pull request Sep 13, 2024

#332 Generate Config Store by default

262272f

- Update documentation to live under supporting components - #219 improve manual action message keys

#3 Added aiSSEMBLE GitHub Action release job

180d90d

jacksondelametter force-pushed the 3-add-release branch from 36b7053 to 180d90d Compare September 13, 2024 18:21

jacksondelametter merged commit 689c412 into dev Sep 13, 2024

jacksondelametter deleted the 3-add-release branch September 13, 2024 18:28

carter-cundiff added a commit that referenced this pull request Sep 13, 2024

#332 Generate Config Store by default

f4f68e7

- Update documentation to live under supporting components - #219 improve manual action message keys

carter-cundiff added a commit that referenced this pull request Sep 13, 2024

#332 Generate Config Store by default

e8a2462

- Update documentation to live under supporting components - #219 improve manual action message keys

carter-cundiff added a commit that referenced this pull request Sep 16, 2024

#332 Generate Config Store by default

04bdc3a

- Update documentation to live under supporting components - #219 improve manual action message keys

carter-cundiff added a commit that referenced this pull request Sep 16, 2024

#332 Generate Config Store by default

e3bef9d

- Update documentation to live under supporting components - #219 improve manual action message keys

carter-cundiff added a commit that referenced this pull request Sep 16, 2024

#332 Generate Config Store by default

602b286

- Update documentation to live under supporting components - #219 improve manual action message keys

carter-cundiff added a commit that referenced this pull request Sep 16, 2024

#332 Generate Config Store by default

b9df16c

- Update documentation to live under supporting components - #219 improve manual action message keys

carter-cundiff added a commit that referenced this pull request Sep 16, 2024

#332 Generate Config Store by default

fc659a9

- Update documentation to live under supporting components - #219 improve manual action message keys

#3 Added aiSSEMBLE GitHub Action release job #332

#3 Added aiSSEMBLE GitHub Action release job #332

Conversation

jacksondelametter commented Sep 12, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aaron-gary left a comment • edited Loading

Choose a reason for hiding this comment

carter-cundiff Sep 13, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jacksondelametter Sep 13, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aaron-gary left a comment •

edited

Loading

carter-cundiff Sep 13, 2024 •

edited

Loading

jacksondelametter Sep 13, 2024 •

edited

Loading