(appset) Filtering by title on Pull Request generator

[jjsiv]

Summary

Currently it is only possible to filter pull requests with the PR generator by target and source branches (also labels in case of Github and Gitlab). I think it would be nice to be able to do some filtering based on the PR title - especially for Git providers such as Bitbucket Server which do not support labels.

Motivation

We use Bitbucket Server and currently we can only filter pull requests based on the source/target branch. Sometimes we would like to perform other actions on the PR before it is picked up by ArgoCD, but as source/target branches are immutable and Bitbucket doesn't support labels, we have no option to do that. Filtering based on the title would allow us to configure ArgoCD to only pick PRs with particular keywords.

Proposal

I can have a look into this

[crenshaw-dev]

Rather than adding a new filter, I think we can take advantage of the existing post-selector.

apiVersion: argoproj.io/v1alpha1
kind: ApplicationSet
metadata:
  name: guestbook
spec:
  goTemplate: true
  generators:
  - pullRequest:
      github:
        owner: myorg
        repo: myrepository
    values:
      titleMatches: '{{ regexMatch "some-regex" .title }}'
    selector:
      matchLabels:
        values.titleMatches: "true"

I haven't tested this, but seems like it should work. We'd still need to add the title parameter, but we'd avoid the new filter field.

[jjsiv]

Indeed, that could be a solution as well. I will try it out locally later and see how it goes

[llavaud]

Rather than adding a new filter, I think we can take advantage of the existing post-selector.

apiVersion: argoproj.io/v1alpha1
kind: ApplicationSet
metadata:
  name: guestbook
spec:
  goTemplate: true
  generators:
  - pullRequest:
      github:
        owner: myorg
        repo: myrepository
    values:
      titleMatches: '{{ regexMatch "some-regex" .title }}'
    selector:
      matchLabels:
        values.titleMatches: "true"

I haven't tested this, but seems like it should work. We'd still need to add the title parameter, but we'd avoid the new filter field.

I don't see the values bloc in the doc neither in the ApplicationSet spec...

[crenshaw-dev]

Ah, we need to add that values field to all generators. Try this.

apiVersion: argoproj.io/v1alpha1
kind: ApplicationSet
metadata:
  name: guestbook
spec:
  goTemplate: true
  generators:
  - matrix:
      generators:
      - pullRequest:
          github:
            owner: myorg
            repo: myrepository
      - list:
          elements:
          - titleMatches: '{{ regexMatch "some-regex" .title }}'
    selector:
      matchLabels:
       titleMatches: "true"

[crenshaw-dev]

Just tested, and that actually works.

[ggjulio]

It seem that the title key is currently not available on argocd 2.10.1

apiVersion: argoproj.io/v1alpha1
kind: ApplicationSet
metadata:
  name: preview
  namespace: argocd
spec:
  goTemplate: true
  goTemplateOptions: ["missingkey=error"]
  generators:
  - matrix:
      generators:
      - pullRequest:
            bitbucketServer:
              project: project-name
              repo: repo-name
              api: https://bitbucket.example.com
              basicAuth:
                // ...
       - list:
            elements:
            - titleMatches: '{{ regexMatch "some-regex" .title }}'
    selector:
      matchLabels:
       titleMatches: "true"
template:
  // ...

[ggjulio]

Rather than adding a new filter, I think we can take advantage of the existing post-selector.

I haven't tested this, but seems like it should work. We'd still need to add the title parameter, but we'd avoid the new filter field.

A PR adding the title parameter is ready for review #17907