This action runs through your recent changes and closes all corresponding AzDO work items if relevant TODO comments were removed in a pushed commit, and converts all newly added TODO comments to new AzDO work items.

Create a workflow file in your .github/workflows/ directory as follows:

name: "TODO-2-AzDO"
on: ["push"]
jobs:
  build:
    runs-on: "ubuntu-latest"
    steps:
      - uses: "actions/checkout@master"
      - name: "TODO-2-AzDO"
        uses: "jamminroot/todo-2-azdo"
        with:
          TOKEN: ${{ secrets.GITHUB_TOKEN }}
          AZDO_TOKEN: ${{ secrets.AZDO_TOKEN}}
          AZDO_ORGANIZATION: ${{ secrets.AZDO_ORGANIZATION}}
          AZDO_TEAM: ${{ secrets.AZDO_TEAM}}
          AZDO_PROJECT: ${{ secrets.AZDO_PROJECT}}
          AZDO_LANE: "TODOs"
          AZDO_CLOSED: "Closed"
          AZDO_NEW: "New"
          TODO_PATTERN: "(?<=\\/\\/ ?TODO[ :]).+"
          LABEL: "TODO"
          TRIM: ",: \""
          TIMEOUT: 1000
          LINES_BEFORE: 2
          LINES_AFTER: 5
          LABELS_PATTERN: "(?<=\\[).+?(?=\\])"
          LABELS_REPLACE_PATTERN: "\\[(.+?)\\]"
          IGNORED_LINES_LENGTH: 255
          EXCLUDED_PATHS: /FilePath/ToExclude/1|/FilePath/ToExclude/2
          INCLUDED_PATHS: /FilePath/ToExclude/1/Exception|/FilePath/ToExclude/2/Exception
          FILE_PATTERN: ".*cs"
        id: "todo-2-azdo"

NOTE: Keep in mind that you have to escape slashes in regex patterns when putting them to yml

NOTE: Always put values for TOKEN, AZDO_TOKEN as secrets in github action preferences. Consider hiding AZDO_ORGANIZATION, AZDO_TEAM and AZDO_PROJECT if that might concern you.

NOTE: INCLUDED_PATHS and EXCLUDED_PATHS use | as separator: /Path1|/Path2, each path must start with / and must use it as separator (your OS does not matter in this case, don't worry - that's just to parse diff correctly). Only beginning of the filepath is checked.

NOTE: TODO labels will only be compared if they follow matching comment pattern.

NOTE: For repositories with binary data consider using IGNORED_LINES_LENGTH to avoid regex getting stuck on processing long lines.

NOTE: For repositories with various data types where you only need to check specific file extensions (e.g. Unity repos), consider using FILE_PATTERN to provide regex to match file pattern. It is only matched against after line length check.

NOTE: If excluded paths list is not empty, and included paths list is, all TODOs are processed if they are not under one of those excluded; If excluded paths list is empty, and included paths list is not, only those TODOs are processed which are under one of those in included list; If both lists are not empty, all TODOs are processed if they are not under one of those excluded (and included paths list acts like a list of exceptions).

+// TODO Change method signature [Easy]
void method() {

}

This will create an issue with the title Change method signature with two labels: [Easy] and the one provided in yml.

-// TODO Change method signature
void method() {

}

Removing the // TODO comment will close the issue on push.

NOTE: Labels, filenames, issue bodies' contents and line numbers are ignored when parsing existing issues.

-// TODO Change method signature
+// TODO [Shower thoughts] Change method signature to something more creative
void method() {

}

Changing the contents of TODO comment will close existing issue (Change method signature) and create new one (Change method signature to something more creative) labelled with 2 labels: [Shower thoughts] and label provided in yml.