As of Backstage 1.15.0, the Azure Devops integration supports service principals and managed identities for enhanced security.
Backstage Merged PR #17780

Requesting to add support for the AzureCredential in addition to the token in the config.

While testing out these actions I ran into an issue with the azure:repo:pr action. It failed with this rather cryptic error message:

[1]2023-11-10T03:19:35.000Z Beginning step Create a Pull Request to Azure Repo
[2]2023-11-10T03:19:35.000Z TypeError: Cannot read properties of null (reading 'value')
[3]    at <anonymous> (/Users/jmezach/Code/rr/Backstage/node_modules/@antoniobergas/scaffolder-backend-module-azure-repositories/node_modules/azure-devops-node-api/VsoClient.js:124:52)
[4]    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)

I managed to fix the issue by passing in the organization parameter, so it seems that that is actually required. But this is not described in the README, nor does it state so in the schema. As also mentioned in #23 I think these actions should maybe accept the output of the RepoPicker directly and then build the appropriate URL's internally.

Hello everybody,

We are using trunk based development and want to allow pushing the changes made by the template to the main branch.
I want to push to the current branch from the azure:repo:push action.
Currently, this fails with the branch already exists because it tries to create a new one.
I have created a fix for it but am not allowed to create branches in this project.
Please find the code snippet below in case you prefer to add it yourself. Otherwise, I am happy to submit a PR if you give me permission.

helpers.ts

... 
 const currentBranch = await git.currentBranch({dir})

  if (currentBranch !== branch) {
    await git.branch({
      dir,
      ref: branch,
    })
  
    await git.checkout({
      dir,
      ref: branch,
    });
  }
...

Let me know if you need more info :)
Thanks!

Hey everyone,

the action azure:repo:clone for some reason requires both repoUrl and remoteUrl. However when i look at the action's code, repoUrl seems to not be used.
The repoUrl parameter is also not documented in the README.md.

Possible solutions could be:

• Removing the repoUrl parameter from the requirements, since it is not used
• Adding the repoUrl to the code example in the README.md, since it is required (in my case i set the repoUrl and the remoteUrl to the same value)
• rename remoteUrl to repoUrl ( more consistency to code of original backstage actions )

if you don't have the time to change that, let me know whats the best option for you so i could create a PR with the changes for this issue for you.

Hi!

We are trying to use this backstage scaffolder actions, unfortunately, I had and error that make me think that somehow the implementation is not compatible with Azure DevOps Server

Is this possible to implement? Will be awesome to have as the pipelines actions works well with Azure DevOps Server and we want to be able to make PRs with the scaffolder 😊

Thanks!

While trying out these actions in a template we've noticed that the clone action doesn't support the URL format that the RepoPicker component generates. Looking at the code it seems to use the provided URL directly, while the built-in publish:azure action actually processes that URL through the parseRepoUrl function from the scaffolder-backend package as can be seen here. I think these actions should do the same.

Hello.
Today i know is possible to put a CUSTOM TITLE for the PR, will be nice to have a field to put a custom description to.

The result should be something like that:

input: organization: <> sourceBranch: <> targetBranch: "develop" repoId: <> title: <> description: MY DESCRIPTION project: <> supportsIterations: false
Tanks for the time...

There is a type error because of type incompatibility between the current version of @backstage/integration and the one you are using.

When initializing the scaffolder router in backend it can be patched with:

cloneAzureRepoAction({ integrations: integrations as any }),
pushAzureRepoAction({
  integrations: integrations as any,
  config: env.config,
}),
pullRequestAzureRepoAction({ integrations: integrations as any }),

To insure type-safety and future compatibility the packages should be updated.

https://github.com/Parfuemerie-Douglas/scaffolder-backend-module-azure-repositories/blame/84413a271b3579b355afa8fc0a8903b4932aecb7/src/actions/run/cloneAzureRepo.ts#L40C19-L40C20

Why don't you move it to the official Backstage repo?
That might help get more contributions.
We are also looking for this functionality and wonder why it is not part of Backstage itself.

Currently I am getting an error when I try to run the azure:repo:push action due to the commitAndPush function in the plugin. I looked at the code and it looks like the branch is being hardcoded to be scaffolder. Could we change this functionality? I'd be happy to open a PR!

Hello everybody,
I am trying to implement the pullRequestAzureRepoAction in my template but it doesn't work for me.
I am using "@parfuemerie-douglas/scaffolder-backend-module-azure-repositories": "^0.2.2" and implemented the code as described in the docs adding in the scaffolder.ts with the imports and

  const actions = [
    ...builtInActions,
    cloneAzureRepoAction({ integrations }),
    pushAzureRepoAction({ integrations, config: env.config }),
    pullRequestAzureRepoAction({ integrations }),
  ];

Now, If I start the app I receive

[1] Backend failed to start up TypeError: (0 , _parfuemerie_douglas_scaffolder_backend_module_azure_repositories__WEBPACK_IMPORTED_MODULE_2__.pullRequestAzureRepoAction) is not a function

If I change the version to 0.2.4-next.2, the app starts normally.
In my template yaml, I added

    - id: pullRequestAzureRepo
      name: Create a Pull Request
      action: azure:repo:pr
      input:
        sourceBranch: <BRANCH>
        targetBranch: main
        repoId: <REPO>
        title: 'Create ${{ parameters.name }}'
        project: <PROJECT>

The previous steps of clone and push work fine and the last step fails with

[1]2023-07-18T13:05:43.247Z Beginning step Create a Pull Request 
[2]2023-07-18T13:05:43.685Z TypeError: Cannot read properties of null (reading 'value')
[3]   at /backstage/node_modules/azure-devops-node-api/VsoClient.js:124:52
[4]   at runMicrotasks (<anonymous>)
[5]   at processTicksAndRejections (node:internal/process/task_queues:96:5)

I have read the docs multiple times and tried changing to use other repos or branches but I end up here again. Could you have a look and maybe help me out?
Happy to submit more info if necessary.

Other dependency versions

    "@backstage/backend-common": "^0.19.0",
    "@backstage/backend-tasks": "^0.5.3",
    "@backstage/catalog-client": "^1.4.2",
    "@backstage/catalog-model": "^1.4.0",
    "@backstage/config": "^1.0.8",
    "@backstage/integration": "^1.5.0",
    "@backstage/plugin-adr-backend": "^0.3.4",
    "@backstage/plugin-app-backend": "^0.3.46",
    "@backstage/plugin-auth-backend": "^0.18.4",
    "@backstage/plugin-auth-node": "^0.2.15",
    "@backstage/plugin-azure-devops-backend": "^0.3.25",
    "@backstage/plugin-catalog-backend": "^1.10.0",
    "@backstage/plugin-catalog-backend-module-azure": "^0.1.17",
    "@backstage/plugin-permission-common": "^0.7.6",
    "@backstage/plugin-permission-node": "^0.7.9",
    "@backstage/plugin-proxy-backend": "^0.2.40",
    "@backstage/plugin-scaffolder-backend": "^1.15.0",
    "@backstage/plugin-search-backend": "^1.3.2",
    "@backstage/plugin-search-backend-module-pg": "^0.5.7",
    "@backstage/plugin-search-backend-node": "^1.2.2",
    "@backstage/plugin-techdocs-backend": "^1.6.3",
    "@parfuemerie-douglas/scaffolder-backend-module-azure-repositories": "^0.2.4-next.2",
    "app": "link:packages/app",
    "dockerode": "^3.3.5",
    "express": "^4.17.1",
    "express-promise-router": "^4.1.0",
    "pg": "^8.11.1",
    "winston": "^3.10.0"

When using the software template actions the cloneAzureRepo (and I'm assuming the subsequent actions relating to Azure repo) fails with: "No token provided for Azure Integration".
After checking this comes due to the new Backstage release version 1.18 and the deprecation of the token field for the Azure Devops Integration. The new structure is as follows:

integrations:
  azure:
    - host: dev.azure.com
      credentials:
      - organizations:
         - organizationName
        personalAccessToken: ${PAT}

But the backend logic as shown here still refers to the old structure and this brings misleading errors when in fact the authorisation should work.
I believe updating the integrationConfig variable to mirror the new structure should fix it.

Problem

While trying to clone a repo using the azure:repo:clone action, I noticed that I am not able to use the branch input successfully (unless we specify the default branch).

Code

id: cloneRepo
name: Clone Azure Repo
action: azure:repo:clone
input:
  remoteUrl: ...
  branch: new-branch
  targetPath: ./new-folder

Error message

2024-06-12T14:11:59.000Z info: Creating new remote...
2024-06-12T14:11:59.000Z info: Checking out branch...
2024-06-12T14:11:59.000Z NotFoundError: Could not find origin/new-branch

For some reason, only using master works. Is this perhaps because the code clones the repository with only the default branch?

Anyone experienced the same issue and have workarounds to this?

Hi!

We are currently running the 1.18.1.next release of backstage, and with the release of 1.18 there has been major work done to the support multiple organizations and by so they have implemented a AzureDevOpsCredentialProvider. Will there be any will to carry this plugin to support the 1.18 backstage version?

Since a beginner at best at typescript a PR from me would probably hurt more then it would help

//Johannes

Hi,
I've been using the azure devops git actions in this repository and I was wondering if I could extend the push by adding a checkout to a new branch then developing another action for submitting a PR. I've forked the current repository, are you alright if I create a PR to this scaffolder action?

Hello! I'm following the instructions in the readme, but when I add the actions to my existing array of actions in scaffolder.ts, I get the following error:

[1] C:\backstage\packages\backend\dist\main.js:444
[1] /******/                    throw e;
[1]                             ^
[1]
[1] TypeError: (0 , smithy_client_1.withBaseException) is not a function
[1]     at Object.<anonymous> (C:\backstage\node_modules\@parfuemerie-douglas\scaffolder-backend-module-azure-repositories\node_modules\@aws-sdk\client-sso\dist-cjs\protocols\Aws_restJson1.js:263:65)
[1]     at Module._compile (node:internal/modules/cjs/loader:1254:14)
[1]     at Module._extensions..js (node:internal/modules/cjs/loader:1308:10)
[1]     at Module.load (node:internal/modules/cjs/loader:1117:32)
[1]     at Module._load (node:internal/modules/cjs/loader:958:12)
[1]     at Module.require (node:internal/modules/cjs/loader:1141:19)
[1]     at require (node:internal/modules/cjs/helpers:110:18)
[1]     at Object.<anonymous> (C:\backstage\node_modules\@parfuemerie-douglas\scaffolder-backend-module-azure-repositories\node_modules\@aws-sdk\client-sso\dist-cjs\commands\GetRoleCredentialsCommand.js:9:25)
[1]     at Module._compile (node:internal/modules/cjs/loader:1254:14)
[1]     at Module._extensions..js (node:internal/modules/cjs/loader:1308:10)
[1]     at Module.load (node:internal/modules/cjs/loader:1117:32)
[1]     at Module._load (node:internal/modules/cjs/loader:958:12)
[1]     at Module.require (node:internal/modules/cjs/loader:1141:19)
[1]     at require (node:internal/modules/cjs/helpers:110:18)
[1]     at Object.<anonymous> (C:\backstage\node_modules\@parfuemerie-douglas\scaffolder-backend-module-azure-repositories\node_modules\@aws-sdk\client-sso\dist-cjs\SSO.js:5:37)
[1]     at Module._compile (node:internal/modules/cjs/loader:1254:14)
[1]
[1] Node.js v18.15.0

Here's the dependencies in my package.json:

  "dependencies": {
    "@backstage/backend-common": "^0.19.0",
    "@backstage/backend-tasks": "^0.5.3",
    "@backstage/catalog-client": "^1.4.2",
    "@backstage/catalog-model": "^1.4.0",
    "@backstage/config": "^1.0.8",
    "@backstage/integration": "^1.5.0",
    "@backstage/plugin-app-backend": "^0.3.46",
    "@backstage/plugin-auth-backend": "^0.18.4",
    "@backstage/plugin-azure-devops-backend": "^0.3.25",
    "@backstage/plugin-catalog-backend": "^1.10.0",
    "@backstage/plugin-catalog-backend-module-azure": "^0.1.17",
    "@backstage/plugin-permission-common": "^0.7.6",
    "@backstage/plugin-permission-node": "^0.7.9",
    "@backstage/plugin-proxy-backend": "^0.2.40",
    "@backstage/plugin-scaffolder-backend": "^1.15.0",
    "@backstage/plugin-search-backend": "^1.3.2",
    "@backstage/plugin-search-backend-module-pg": "^0.5.7",
    "@backstage/plugin-search-backend-node": "^1.2.2",
    "@backstage/plugin-techdocs-backend": "^1.6.3",
    "@mdude2314/backstage-plugin-scaffolder-git-actions": "1.1.0",
    "@mdude2314/backstage-plugin-scaffolder-json-merge-actions": "^1.1.0",
    "@mdude2314/backstage-plugin-scaffolder-npm-actions": "^1.1.0",
    "@mdude2314/backstage-plugin-search-backend-module-azure-devops-wiki": "^0.4.0",
    "@parfuemerie-douglas/scaffolder-backend-module-azure-pipelines": "^1.0.0-next.5",
    "@parfuemerie-douglas/scaffolder-backend-module-azure-repositories": "^0.2.4-next.2",
    "@plusultra/plugin-scaffolder-dotnet-backend": "^1.1.1",
    "app": "link:../app",
    "dockerode": "^3.3.1",
    "express": "^4.17.1",
    "express-promise-router": "^4.1.0",
    "json-merger": "^1.1.9",
    "pg": "^8.3.0",
    "winston": "^3.2.1"
  }

And the code in scaffolder, obfuscated for brevity/secrets:

/// scaffolder.ts
import {
  cloneAzureRepoAction,
  pushAzureRepoAction,
  pullRequestAzureRepoAction,
} from '@parfuemerie-douglas/scaffolder-backend-module-azure-repositories';

 const builtInActions = createBuiltinActions({
    catalogClient,
    integrations,
    config: env.config,
    reader: env.reader,
  });

  const actions = [
    ...builtInActions,
    cloneAzureRepoAction({ integrations }),
    pushAzureRepoAction({ integrations, config: env.config }),
    pullRequestAzureRepoAction({ integrations }),
    dotnetNewAction(),
    dotnetBuildAction(),
    gitCloneAction(),
    gitAction(),
    dotnetInstallTemplateAction(),
    createNpmExecAction(),
    createNpmInitAction(),
    createNpmInstallAction(),
    createNpmConfigAction(),
    createJsonMergeFilesAction(),
    createJsonMergeFileAction(),
  ];

  return await createRouter({
    logger: env.logger,
    config: env.config,
    database: env.database,
    reader: env.reader,
    catalogClient,
    actions,
  });

Any ideas what I'm missing here?