Create reusable image deploy workflow #3
Conversation
This reverts commit 99a0126.
| run: echo "::set-output name=sha7::$(echo ${GITHUB_SHA} | cut -c1-7)" | ||
|
|
||
| - name: Copy checksum files | ||
| run: aws s3 cp image-digest.txt s3://${{ secrets.AWS_BUCKET }}/${{ env.S3_FOLDER }}-${{ steps.slug.outputs.sha7 }}/${{ inputs.quayRepository }}/image-digest.txt |
There was a problem hiding this comment.
Note: the image digest is now uploaded to a folder with the quay image name. For example, s3://***/1.16.0-alpha.1-ae8db5d/dockstore-support/image-digest.txt (this folder doesn't exist so don't look for it 🙂)
There was a problem hiding this comment.
Alot of these steps are copied from https://github.com/dockstore/dockstore/blob/b604742ab675b6ca47629e7e54a71478c6247191/.github/workflows/deploy_tagged.yml#L1 with a few modifications so that it can be reused by multiple repositories
.github/workflows/deploy_tagged.yaml
Outdated
| distribution: 'adopt' | ||
|
|
||
| - name: Set changelist |
There was a problem hiding this comment.
This allows us to call the tagged release workflow without providing the changelist version. This info is already part of the tag so this step is just figuring out the changelist version from the tag
There was a problem hiding this comment.
Neat!
Just to think it through, does this need error handling in the case that someone accidentally makes a tag like
1.17-alpha.0
There was a problem hiding this comment.
To be clear, not because I want to support it, just to have it die gracefully
| @@ -1,54 +1,27 @@ | |||
| name: Reusable tagged release deploy | |||
|
|
|||
| on: | |||
| workflow_dispatch: | |||
There was a problem hiding this comment.
I don't think this section is needed. The calling workflow should have the workflow_dispatch defined so this isn't actually used.
.github/workflows/deploy_tagged.yaml
Outdated
| distribution: 'adopt' | ||
|
|
||
| - name: Set changelist |
There was a problem hiding this comment.
Neat!
Just to think it through, does this need error handling in the case that someone accidentally makes a tag like
1.17-alpha.0
| # settings.xml configuration | ||
| server-id: ${{ github.ref_type == 'tag' && 'central' || 'snapshots' }} | ||
| server-username: DEPLOY_USERNAME | ||
| server-password: DEPLOY_TOKEN |
There was a problem hiding this comment.
Defining this allows us to remove all the duplicated settings.xml files across the various repos that upload artifacts to artifactory.
| set -x | ||
| if ${{ github.ref_type == 'tag' }}; then | ||
| # Check that the tag follows semantic versioning. Note that the regex is not super strict | ||
| if [[ ${{ github.ref_name }} =~ ^[0-9]+\.[0-9]+\.[0-9a-zA-Z-]+$ ]]; then |
There was a problem hiding this comment.
This is a simple check just to make sure that the tag generally follows semantic versioning. There is a much stricter regex out there, but I figured it might be overkill here
| set -x | ||
| if ${{ github.ref_type == 'tag' }}; then | ||
| # Check that the tag follows semantic versioning. Note that the regex is not super strict | ||
| if [[ ${{ github.ref_name }} =~ ^[0-9]+\.[0-9]+\.[0-9a-zA-Z-]+(-[0-9a-zA-Z-]+\.[0-9a-zA-Z-]+)*$ ]]; then |
There was a problem hiding this comment.
This regex is not as strict as https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string because that might be overkill/hard to read... thoughts?
There was a problem hiding this comment.
As long as it matches the patterns that appear in our refs, should be fine, imho
https://ucsc-cgl.atlassian.net/browse/SEAB-6771
This PR:
deploy_image.yamlworkflow that uploads an image to quay and the image digest to S3.deploy_artifacts.yamlworkflow that uses maven to deploy artifacts to artifactory, and optionally invokesdeploy_image.yamlto deploy an image.Tagged release deploythat we're used to.1.17.0-SNAPSHOT. A feature branch snapshot is named1.17.0-<branch-name-where-slashes-are-subbed-with-hyphens>-SNAPSHOTlike1.17.0-feature-seab-6771-reusable-image-deploy-SNAPSHOT.See the following PRs where these workflows are used: