paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 37 Packages Projects Releases Wiki Activity

minor fix & documentation updated

Browse Source 
Signed-off-by: Deepankumar Loganathan <deepan0433@gmail.com>
This commit is contained in:
Deepankumar Loganathan
2024-02-10 10:25:34 +01:00
parent bfd63c99f6
commit 5ac4adc1eb
3 changed files with 13 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/azure-devops/README.md
+11 -6
View File
@@ -322,9 +322,11 @@ To get the README component working you'll need to do the following two steps:
## Permission Framework
Azure DevOps plugin is now supporting the permission framework for PRs, GitTags, Pipelines & ReadMe.
Azure DevOps plugin supports the permission framework for PRs, GitTags, Pipelines and Readme features.
To enable the permission on the legacy backend system add the below config in `packages/backend/src/plugins/azure-devops.ts`.
New Backend you can skip the below and proceed with [permission configuration](#configure-permission)
To enable permissions for the legacy backend system in `packages/backend/src/plugins/azure-devops.ts` add the following.
```diff
export default async function createPlugin(
@@ -341,17 +343,18 @@ export default async function createPlugin(
### Configure Permission
To apply the permission rule add the following in `packages/backend/src/plugins/permissions.ts`.
To apply the permission rules add the following in `packages/backend/src/plugins/permissions.ts`.
> Note this is example only `azureDevOpsPullRequestDashboardReadPermission` is Basic permission rest all Resource Permission. As an adopter you can configure how you wanted.
> Note: the following is just an example of how you might want to setup permissions, as an Adopter you can configure this to fit your needs. Also all the permissions are Resource Permissions as they work with an Entity with the exception of `azureDevOpsPullRequestDashboardReadPermission`.
```diff
+ import {
+ azureDevOpsPullRequestReadPermission,
+ azureDevOpsPipelineReadPermission,
+ azureDevOpsGitTagReadPermission,
+ azureDevOpsReadmeReadPermission,
+ azureDevOpsPullRequestDashboardReadPermission } from '@backstage/azure-devops-common';
+ azureDevOpsPullRequestDashboardReadPermission } from '@backstage/plugin-azure-devops-common';
...
async handle(
request: PolicyQuery,
@@ -361,7 +364,7 @@ async handle(
+ isPermission(request.permission, azureDevOpsPipelineReadPermission) ||
+ isPermission(request.permission, azureDevOpsGitTagReadPermission) ||
+ isPermission(request.permission, azureDevOpsReadmeReadPermission)) {
+ return createTodoListConditionalDecision(
+ return createCatalogConditionalDecision(
+ request.permission,
+ catalogConditions.isEntityOwner({
+ claims: user?.identity.ownershipEntityRefs ?? [],
@@ -370,7 +373,9 @@ async handle(
+ }
+ if ( isPermission(request.permission, azureDevOpsPullRequestDashboardReadPermission) {
+ return {
+ result: AuthorizeResult.ALLOW,
+ };
+ }
return {
plugins/azure-devops/src/api/AzureDevOpsClient.ts
+1
View File
@@ -198,6 +198,7 @@ export class AzureDevOpsClient implements AzureDevOpsApi {
if (opts.path) {
queryString.append('path', opts.path);
}
queryString.append('entityRef', opts.entityRef);
return await this.get(
`readme/${encodeURIComponent(opts.project)}/${encodeURIComponent(
opts.repo,