v0.1 of GHA release automation #3094

madchap · 2020-10-25T22:12:57Z

Base master is right.

This PR brings some automation to our release process. This is a v0.1 which I feel confident we can try for 1.9.0, but will appreciate eyes on it prior to that.

[Triggered manually with maintainer input on version number] The first workflow will checkout dev, create a release branch, change version in files and commit them to finish by creating a PR. At that point, whoever is doing the release will review and take appropriate action. In the future, that PR may be dismissed for a full automated release.

Example of a manually merged PR, created by the GHA

The PR created by the 1st workflow needs to be merged before proceeding.

[Triggered manually for now with maintainer input on version number, can change later to trigger on PR merge from step 1] This second workflow (which is 2 and 3 merged because of limitations on calling a workflow from another workflow) will create a tag, create a draft release (will have to copy-paste some release drafter note before manually publishing for now) and build&push docker images.

~~3. Added a third action to merge master back to dev.~~

ptrovatelli

seems promising! could you check my remarks please? could you maybe let the result of the workflows sit somewhere for us to see what's the end result?

thanks!

.github/workflows/new-release-merge-back-to-master-pr.yml

ptrovatelli · 2020-10-27T13:08:02Z

.github/workflows/new-release-pr.yml

+      - name: Update version numbers in key files
+        run: |
+          # sed -ri "s/'([0-9]+(\.[0-9]+)*)'/'${{ github.event.inputs.release_number }}'/" dojo/__init__.py
+          sed -ri "s/__version__ = '.*'/__version__ = '${{ github.event.inputs.release_number }}'/" dojo/__init__.py
+          sed -ri "s/version='.*'/version='${{ github.event.inputs.release_number }}'/" setup.py
+          sed -ri "s/appVersion: \"([0-9]+(\.[0-9]+)*)\"/appVersion: \"${{ github.event.inputs.release_number }}\"/" helm/defectdojo/Chart.yaml
+      - name: Check numbers
+        run: |
+          grep version dojo/__init__.py
+          grep version setup.py
+          grep appVersion helm/defectdojo/Chart.yaml
+      - name: Push version changes
+        uses: stefanzweifel/git-auto-commit-action@v4.1.2
+        with:
+          commit_user_name: "${{ env.GIT_USERNAME }}"
+          commit_user_email: "${{ env.GIT_EMAIL }}"
+          commit_author: "${{ env.GIT_USERNAME }} <${{ env.GIT_EMAIL }}>"
+          commit_message: "Update versions in application files"
+          branch: ${{ github.head_ref }}
+      - id: set-repo-org


if we change the version on dev branch before running this workflow, this duplicated version managment can be removed

You mean like manually modifying before running the workflow?

in the workflow. same as new-release-pr.yml but merges to dev instead of master, and rename the file to 01-version-change-on-dev-pr.yml.

if we remove the new-release-merge-back-to-master-pr.yml the version will be outdated in dev branch. it was serving at least this purpose although it's a pretty ugly way to have this version set in dev branch

as discussed: the version in dev is diffferent than the version in the release so OK to leave it as it is for now

ptrovatelli · 2020-10-27T13:35:23Z

or, how about this?

step 1: create a release branch, commit the version changes, merge the release branch to dev (same as new-release-pr.yml but merges to dev instead of master, and rename the file to 01-version-change-on-dev-pr.yml)
step 2: merge dev to master (new workflow to create 02-merge-dev-to-master-pr.yml)
step 3: merge master to dev: this is just in case, in most cases the PR should be cancelled. (same as new-release-merge-back-to-master-pr.yml but no version handling required and rename as 03-merge-master-to-dev-pr.yml)

madchap · 2020-10-27T14:08:20Z

or, how about this?

step 1: create a release branch, commit the version changes, merge the release branch to dev (same as new-release-pr.yml but merges to dev instead of master, and rename the file to 01-version-change-on-dev-pr.yml)

step 2: merge dev to master (new workflow to create 02-merge-dev-to-master-pr.yml)

step 3: merge master to dev: this is just in case, in most cases the PR should be cancelled. (same as new-release-merge-back-to-master-pr.yml but no version handling required and rename as 03-merge-master-to-dev-pr.yml)

The goal was not to re-imagine our release process, rather automate the existing one.

Be my guest to rework these in another PR.

ptrovatelli · 2020-10-27T16:07:12Z

or, how about this?

step 1: create a release branch, commit the version changes, merge the release branch to dev (same as new-release-pr.yml but merges to dev instead of master, and rename the file to 01-version-change-on-dev-pr.yml)

step 2: merge dev to master (new workflow to create 02-merge-dev-to-master-pr.yml)

step 3: merge master to dev: this is just in case, in most cases the PR should be cancelled. (same as new-release-merge-back-to-master-pr.yml but no version handling required and rename as 03-merge-master-to-dev-pr.yml)

The goal was not to re-imagine our release process, rather automate the existing one.

Be my guest to rework these in another PR.

it's almost the same, just more straight forward and with less code duplication. we can discuss this and if everyone agree I can do the changes this week

valentijnscholten · 2020-10-27T17:32:30Z

nice job @madchap. At some point I'd like to see if we can get rid of that json (de)serialization parts that looks a bit out of place. Otherwise great to have some automation. Automate the release, so we have more time discuss topics on the agenda in the future.
Glad to have the release process ironed out so it doesn't need much more discussion.

madchap added the maintenance label Oct 25, 2020

working v0.1 with caveats

04e81a0

madchap force-pushed the release-automation branch from f82d20f to 04e81a0 Compare October 25, 2020 22:16

madchap added 3 commits October 26, 2020 13:54

explicit master

9cf063c

post-release pr to merge master->dev

af0f4d9

variabilize repo org

1fa5109

ptrovatelli requested changes Oct 27, 2020

View reviewed changes

addressing comments

facfa8a

removing the last step, will need more work or thoughts

d3f9e2d

madchap requested a review from ptrovatelli October 27, 2020 17:25

ptrovatelli approved these changes Oct 27, 2020

View reviewed changes

devGregA requested review from devGregA and ptrovatelli October 27, 2020 17:25

devGregA approved these changes Oct 27, 2020

View reviewed changes

madchap merged commit af9c71d into DefectDojo:master Oct 27, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

v0.1 of GHA release automation #3094

v0.1 of GHA release automation #3094

madchap commented Oct 25, 2020 •

edited

Loading

ptrovatelli left a comment

ptrovatelli Oct 27, 2020 •

edited

Loading

madchap Oct 27, 2020

ptrovatelli Oct 27, 2020

ptrovatelli Oct 27, 2020

ptrovatelli commented Oct 27, 2020 •

edited

Loading

madchap commented Oct 27, 2020

ptrovatelli commented Oct 27, 2020

valentijnscholten commented Oct 27, 2020

v0.1 of GHA release automation #3094

v0.1 of GHA release automation #3094

Conversation

madchap commented Oct 25, 2020 • edited Loading

ptrovatelli left a comment

Choose a reason for hiding this comment

ptrovatelli Oct 27, 2020 • edited Loading

Choose a reason for hiding this comment

madchap Oct 27, 2020

Choose a reason for hiding this comment

ptrovatelli Oct 27, 2020

Choose a reason for hiding this comment

ptrovatelli Oct 27, 2020

Choose a reason for hiding this comment

ptrovatelli commented Oct 27, 2020 • edited Loading

madchap commented Oct 27, 2020

ptrovatelli commented Oct 27, 2020

valentijnscholten commented Oct 27, 2020

madchap commented Oct 25, 2020 •

edited

Loading

ptrovatelli Oct 27, 2020 •

edited

Loading

ptrovatelli commented Oct 27, 2020 •

edited

Loading