release-1-create-pr.yml

name: "Release-1: Create PR for master"

env:
  GIT_USERNAME: "DefectDojo release bot"
  GIT_EMAIL: "dojo-release-bot@users.noreply.github.com"
on:
  workflow_dispatch:
    inputs:
      # the actual branch that can be chosen on the UI is made irrelevant by further steps
      # because someone will forget one day to change it.
      from_branch:
        description: "Select branch to release from. Dev branch releases happen the first monday of the month. Otherwise, use bugfix."
        required: true
        type: choice
        default: 'bugfix'
        options:
          - bugfix
          - dev
      release_number:
        description: "Release version (x.y.z format)"
        required: true

jobs:
  create_pr:
    runs-on: ubuntu-latest
    steps:
      - name: Validate proper bugfix branch release_number format is being used
        if: ${{ inputs.from_branch == 'bugfix' }}
        run: |
          # Expect the last octet in release_number to not be 0
          echo "${{ inputs.release_number }}" | grep "^[0-9]*\.[0-9]*\.[1-9]$"

      - name: Validate proper dev branch release_number format is being used
        if: ${{ inputs.from_branch == 'dev' }}
        run: |
          # Expect the last octet in release_number to not be 1-9
          echo "${{ inputs.release_number }}" | grep "^[0-9]*\.[0-9]*\.0$"

      - id: Set-GitHub-org
        run: echo "GITHUB_ORG=${GITHUB_REPOSITORY%%/*}" >> $GITHUB_ENV

      - name: Checkout from_branch branch
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          ref: ${{ inputs.from_branch }}

      - name: Create release branch
        run: |
          echo "NEW_BRANCH=release/${{ inputs.release_number }}" >> $GITHUB_ENV

      - name: Configure git
        run: |
          git config --global user.name "${{ env.GIT_USERNAME }}"
          git config --global user.email "${{ env.GIT_EMAIL }}"

      - name: Push branch
        if: "!startsWith('${{ inputs.from_branch }}', 'release/')"
        run: git push origin HEAD:${NEW_BRANCH}

      - name: Checkout release branch
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          ref: ${{ env.NEW_BRANCH }}

      - name: Update version numbers in key files
        run: |
          sed -ri 's/__version__ = ".*"/__version__ = "${{ inputs.release_number }}"/' dojo/__init__.py
          sed -ri 's/"version": ".*"/"version": "${{ inputs.release_number }}"/' components/package.json
          sed -ri 's/appVersion: ".*"/appVersion: "${{ inputs.release_number }}"/' helm/defectdojo/Chart.yaml

          if grep "\-dev" helm/defectdojo/Chart.yaml; then
              echo "x.y.z-dev found in Chart.yaml, probably releasing a new minor version"
              echo "removing the -dev suffix"
              sed -e "s/\-dev//" -i helm/defectdojo/Chart.yaml
          else
              echo "x.y.z without -dev found in Chart.yaml, probably releasing a new bug fix version"
              CURRENT_CHART_VERSION=$(grep -oP 'version: (\K\S*)?' helm/defectdojo/Chart.yaml | head -1)
              NEW_CHART_VERSION=$(echo "version: $CURRENT_CHART_VERSION" | awk -F. -v OFS=. 'NF==1{print ++$NF}; NF>1{$NF=sprintf("%0*d", length($NF), ($NF+1)); print}')
              echo "bumping the chart version from $CURRENT_CHART_VERSION to $NEW_CHART_VERSION"
              sed -ri "0,/version/s/version: \S+/$NEW_CHART_VERSION/" helm/defectdojo/Chart.yaml
          fi

      - name: Update values in HELM chart
        run: |
          yq -i '.annotations."artifacthub.io/prerelease" = "false"' helm/defectdojo/Chart.yaml
          yq -i '.annotations."artifacthub.io/changes" += "- kind: changed\n  description: Bump DefectDojo to ${{ inputs.release_number }}\n"' helm/defectdojo/Chart.yaml

      - name: Check version numbers
        run: |
          grep -H version dojo/__init__.py
          grep -H version components/package.json
          grep -H appVersion helm/defectdojo/Chart.yaml
          grep -H version helm/defectdojo/Chart.yaml

      - name: Run helm-docs
        uses: losisin/helm-docs-github-action@2ccf3e77eb70dc80d62f8cc26f15d0a96b75fef4 # v1.8.0
        with:
          chart-search-root: "helm/defectdojo"

      - name: Push version changes
        uses: stefanzweifel/git-auto-commit-action@04702edda442b2e678b25b537cec683a1493fcb9 # v7.1.0
        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: ${{ env.NEW_BRANCH }}

      - name: Create Pull Request
        uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          script: |
            const pr = await github.rest.pulls.create({
              owner: '${{ env.GITHUB_ORG }}',
              repo: 'django-DefectDojo',
              title: 'Release: Merge release into master from: ${{ env.NEW_BRANCH }}',
              body: `Release triggered by \`${ process.env.GITHUB_ACTOR }\``,
              head: '${{ env.NEW_BRANCH }}',
              base: 'master'
            })
            await github.rest.issues.addLabels({
              owner: '${{ env.GITHUB_ORG }}',
              repo: 'django-DefectDojo',
              issue_number: pr.data.number,
              labels: ['release-management']
            })