The pull pipeline should fail if old PR is still active during automated pull

[nishantmittal6239]

Description:
We have a pull pipeline which run after every 6 hours to fetch the latest changes from the portal. This pipeline creates a PR that requires a manual approval so If the PR is not approved and completed before the next pull run then it should fail the pipeline instead of just giving the message. See screenshot attached.

Screenshots

[jsandquist]

Hi nishantmittal6239,
this seems to match my use-case so I think a better option might be for you to comment out the complete operation if PR is still active - this line

# az repos pr update --status completed --id $PRid --bypass-policy true --bypass-policy-reason "Automated pull request" > /dev/null 2>&1

Then you will see additional updates to the active PR instead - and each update based on the latest commit to 'main' if there has been any other changes in between.

Works quite well for me!

[daltondhcp]

nishantmittal6239 , Jan Sandquist (@jsandquist),
Do you think this is something we should change in terms of the default behavior, or provide as an additional option?

[jsandquist]

An additional option could be fine - to communicate that there is an alternative way the client might prefer or at least consider.

[daltondhcp]

Jan Sandquist (@jsandquist) - do you want to make a contribution to the pipeline with this as an option?

[jsandquist]

Sure - I can give it a go. Further discussions in the PR as soon as it shows up around here somewhere...

The setting should probably go into a variable group for Azure Pipelines. And similar for GitHub Actions. My first cut below - for Azure Pipelines and rather untested - where PowerShell might be preferred following AzOps-Accelerator#120:

  - task: Bash@3
    displayName: "Merge"
    condition: contains(variables['state'], 'continue')
    inputs:
      targetType: "inline"
      script: |
        # Check if active PR already exists
        PRActive=$(
          az repos pr list \
          --source-branch "$(branch)" \
          --target-branch "main" \
          --status "active" \
          --repository "$(repository_name)" \
        );

        if [ -z "$PRActive" ]
        then
          echo "No active PR - creating new PR"
        else
          PRid=$(echo $PRActive | jq -r '.[0].pullRequestId');
          echo "Active Pull Request already exists - nothing more to do: $PRid"
          exit
        fi

        # Open new PR
        PROut=$(
          az repos pr create \
          --title "$(pull_request)" \
          --source-branch "$(branch)" \
          --target-branch "main" \
          --squash true \
          --delete-source-branch true \
          --auto-complete true \
          --repository "$(repository_name)" \
        );

        # Get PR ID and check status
        PRid=$(echo $PROut | jq -r '.pullRequestId');
        PRStatus=$(az repos pr show --id $PRid | jq .status);
        echo "New Pull Request created with Id: $PRid"

        # If PR is not completed, then complete it bypassing policy (not allowed so commented out for now)
        if [ $PRStatus == "\"active\"" ]; then
          echo "Completing PR bypassing branch policy - would have been done here - if permitted but now a no-op"
          # az repos pr update --status completed --id $PRid --bypass-policy true --bypass-policy-reason "Automated pull request" > /dev/null 2>&1
        fi;
    env:
          AZURE_DEVOPS_EXT_PAT: $(System.AccessToken)

[daltondhcp]

This looks good to me, feel free to continue with PR in the accelerator-repo as well as wiki.