Skip to content

[NVSHAS-9891] Azure DevOps Remote Repository Config Information #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[NVSHAS-9891] Azure DevOps Remote Repository Config Information #165

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2f38e78
Updating the Navigation page with Azure DevOps remote repository conf…
sunilarjun Mar 26, 2025
b013572
Splitting the configs into two sections after review and adding versi…
sunilarjun Apr 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions docs/04.navigation/01.navigation/01.navigation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,22 +167,33 @@ An integration with [IBM Security Advisor](/integration/ibmsa) and [QRadar](/int

##### Remote Repository Configuration

Configure a remote GitHub repository that can be used when exporting CRD files.
Configure a remote GitHub or Azure DevOps repository that can be used when exporting CRD files.

In order to setup the remote repository, you need to provide the following information:

| Field | Type | Description |
| --- | --- | --- |
| Repository Provider | Mandatory | Select the repository provider. Currently, only GitHub is supported. |
| Repository Provider | Mandatory | Select the repository provider. Currently, GitHub and Azure DevOps are supported. |
| Owner User Name | Mandatory | The repository owner's GitHub username. |
| Repository Name | Mandatory | The repository name. |
| Organization Name | Mandatory | The name of your Azure DevOps organization. |
| Project Name | Mandatory | The Azure DevOps project that contains the repository. |
| Personal Access Token | Mandatory | Grant the "repo" scope to the token. Obtain it from https://github.com/settings/tokens or https://dev.azure.com/{Your_Organization}/_usersSettings/tokens. |
| Branch Name | Optional | The specific branch within the repository that contains the CRD files. The default branch is 'main'. |
| Committer Name | Optional | The name of the committer associated with the personal access token. |
| Comment | Optional | The comment associated with the commit. |
| Repository Name | Mandatory | The repository name. |
| Personal Access Token | Mandatory | Grant the "repo" scope to the token. Obtain it from https://github.com/settings/tokens. |
| Email | Optional | The email address associated with the committer. |

![Example of a remote repository configuration](remote_repository_configuration.png)
<details>
<summary>Sample Remote Repository Configurations</summary>

+ GitHub:
![Example of a remote repository configuration](remote_repository_configuration.png)

+ Azure DevOps:
![Example of an Azure DevOps remote repository configuration](ADO_remote_repository_configuration.png)

</details>

Once the information is provided, click on the 'Submit' button to save the configuration.

Expand Down
Binary file added docs/04.navigation/01.navigation/ADO_remote_repository_configuration.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 16 additions & 5 deletions versioned_docs/version-5.4/04.navigation/01.navigation/01.navigation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,22 +167,33 @@ An integration with [IBM Security Advisor](/integration/ibmsa) and [QRadar](/int

##### Remote Repository Configuration

Configure a remote GitHub repository that can be used when exporting CRD files.
Configure a remote GitHub or Azure DevOps repository that can be used when exporting CRD files.

In order to setup the remote repository, you need to provide the following information:

| Field | Type | Description |
| --- | --- | --- |
| Repository Provider | Mandatory | Select the repository provider. Currently, only GitHub is supported. |
| Repository Provider | Mandatory | Select the repository provider. Currently, GitHub and Azure DevOps are supported. |
| Owner User Name | Mandatory | The repository owner's GitHub username. |
| Repository Name | Mandatory | The repository name. |
| Organization Name | Mandatory | The name of your Azure DevOps organization. |
| Project Name | Mandatory | The Azure DevOps project that contains the repository. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this section shared between Azure & GitHub? It could be confusing because the Project Name field is not required for GitHub exports, but is required for Azure Devops exports.

Copy link
Contributor Author

@sunilarjun sunilarjun Apr 10, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The section is shared and after reviewing I split the table into two sections for each respective provider (commit reference). Let me know if it looks alright and thank you for reviewing!

| Personal Access Token | Mandatory | Grant the "repo" scope to the token. Obtain it from https://github.com/settings/tokens or https://dev.azure.com/{Your_Organization}/_usersSettings/tokens. |
| Branch Name | Optional | The specific branch within the repository that contains the CRD files. The default branch is 'main'. |
| Committer Name | Optional | The name of the committer associated with the personal access token. |
| Comment | Optional | The comment associated with the commit. |
| Repository Name | Mandatory | The repository name. |
| Personal Access Token | Mandatory | Grant the "repo" scope to the token. Obtain it from https://github.com/settings/tokens. |
| Email | Optional | The email address associated with the committer. |

![Example of a remote repository configuration](remote_repository_configuration.png)
<details>
<summary>Sample Remote Repository Configurations</summary>

+ GitHub:
![Example of a remote repository configuration](remote_repository_configuration.png)

+ Azure DevOps:
![Example of an Azure DevOps remote repository configuration](ADO_remote_repository_configuration.png)

</details>

Once the information is provided, click on the 'Submit' button to save the configuration.

Expand Down
Binary file added ...version-5.4/04.navigation/01.navigation/ADO_remote_repository_configuration.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.