Skip to content

Commit 861704c

Browse files
vbossicaatbagga
vbossica
authored and
atbagga
committed
Fix markdownlint issues (#383)
fix markdownlint warnings
1 parent ce2104f commit 861704c

9 files changed

+404
-350
lines changed

‎.mdlrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
rules "~MD013", "~MD033", "~MD046"

‎CONTRIBUTING.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -4,39 +4,39 @@ Thank you for your interest in contributing to the Azure DevOps Extension!
44

55
There are many ways in which you can contribute, beyond writing code. The goal of this document is to provide a high-level overview of how you can get involved.
66

7-
# Have a question
7+
## Have a question
88

99
Search existing github [issues](https://github.com/Microsoft/azure-devops-cli-extension/issues?q=is%3Aopen+is%3Aissue+label%3Aquestion) for similar questions first, and feel free to file an issue with a "question" tag to get our attention.
1010

11-
# Found a bug
11+
## Found a bug
1212

13-
#### Where to find known issues
13+
### Where to find known issues
1414

1515
Check open [issues](https://github.com/Microsoft/azure-devops-cli-extension/issues?q=is%3Aopen+is%3Aissue+label%3Abug) before you file a new bug report.
1616

1717
If you find your issue already exists, make relevant comments and add your reaction. Use a reaction in place of a "+1" comment:
1818
👍 - upvote
1919
👎 - downvote
2020

21-
#### Report new issue
21+
### Report new issue
2222

2323
The best way to get your bug fixed is to provide good repro steps. Use our [Bug template](https://github.com/Microsoft/azure-devops-cli-extension/issues/new/choose) to report any issues.
2424

25-
# Feature requests
25+
## Feature requests
2626

27-
#### Where to find existing requests
27+
### Where to find existing requests
2828

2929
Check open [feature requests](https://github.com/Microsoft/azure-devops-cli-extension/issues?q=is%3Aissue+is%3Aopen+label%3AFeature) before you file a new request.
3030

3131
If you find your request already exists, make relevant comments and add your reaction. Use a reaction in place of a "+1" comment:
3232
👍 - upvote
3333
👎 - downvote
3434

35-
#### Submit New Feature request
35+
### Submit New Feature request
3636

3737
Use our Feature Request [template](https://github.com/Microsoft/azure-devops-cli-extension/issues/new/choose) to create a new feature request.
3838

39-
# Get started
39+
## Get started
4040

4141
Unsure where to begin contributing? You can start by looking through these beginner and help-wanted issues:
4242

@@ -46,36 +46,36 @@ Unsure where to begin contributing? You can start by looking through these begin
4646

4747
Refer our [Developer setup](./doc/dev_setup.md) instructions to get started with code and running tests.
4848

49-
## Code of Conduct
49+
### Code of Conduct
5050

5151
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected])with any additional questions or comments.
5252

53-
## Pull Request etiquette
53+
### Pull Request etiquette
5454

55-
### Guidelines
55+
#### Guidelines
5656

5757
- Every contribution (PR) needs to have an issue referenced
5858
- Approach(s) should be discussed and closed in the issue itself before raising a PR
5959
- We use pylint and flake8 to have consistent coding styles followed. This is taken care in the Pull request checks.
6060

61-
### If PR contains new commands
61+
#### If PR contains new commands
6262

6363
- Recorded tests are mandatory
6464
- UTs are mandatory
6565
- Command signature should be discussed and approved in referenced issue. [Sample](https://github.com/Microsoft/azure-devops-cli-extension/issues/319)
6666
- Table transforms are present (reviewed in PR)
6767
- Help text is present for commands and parameters
6868

69-
### If PR contains point fixes
69+
#### If PR contains point fixes
7070

7171
- UTs are mandatory
7272

73-
## CLA requirements
73+
### CLA requirements
7474

7575
You will need to complete a Contributor License Agreement (CLA). Briefly, this agreement testifies that you are granting us permission to use the submitted change according to the terms of the project's license, and that the work being submitted is under appropriate copyright.
7676

77-
Submit a Contributor License Agreement (CLA) before submitting a pull request. You may visit https://cla.microsoft.com to sign digitally.
77+
Submit a Contributor License Agreement (CLA) before submitting a pull request. You may visit [https://cla.microsoft.com](https://cla.microsoft.com) to sign digitally.
7878

79-
# Thank you!
79+
## Thank you
8080

8181
Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute.

‎README.md

+28-25
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,49 @@
11
[![Build Status](https://dev.azure.com/AzureDevOpsCliOrg/AzureDevOpsCli/_apis/build/status/YAML/Azure%20DevOps%20CLI%20-%20Merge%20GitHub%20YAML?branchName=master)](https://dev.azure.com/AzureDevOpsCliOrg/AzureDevOpsCli/_build/latest?definitionId=38&branchName=master)
22

3-
43
# Azure DevOps Extension for Azure CLI
54

6-
7-
The Azure DevOps Extension for Azure CLI adds Pipelines, Boards, Repos, Artifacts and DevOps commands to the Azure CLI 2.0.
5+
The Azure DevOps Extension for Azure CLI adds Pipelines, Boards, Repos, Artifacts and DevOps commands to the Azure CLI 2.0.
86

97
> The Azure DevOps Extension is currently in preview but we encourage you to give it a try and provide feedback (or contribute).
108
>
11-
>The Azure CLI with the Azure DevOps Extension has replaced the VSTS CLI. The VSTS CLI has been deprecated and will no longer be receiving new features. We recommend that users of the VSTS CLI switch to the Azure CLI and add the Azure DevOps extension. See the [Command Mapping](/doc/command_mapping.md) section to view the mapping between VSTS CLI and Azure DevOps Extension commands.
9+
>The Azure CLI with the Azure DevOps Extension has replaced the VSTS CLI. The VSTS CLI has been deprecated and will no longer be receiving new features. We recommend that users of the VSTS CLI switch to the Azure CLI and add the Azure DevOps extension. See the [Command Mapping](/doc/command_mapping.md) section to view the mapping between VSTS CLI and Azure DevOps Extension commands.
1210
11+
## Quick start
1312

14-
# Quick start
13+
1. [Install the Azure CLI](https://docs.microsoft.com/cli/azure/install-azure-cli). You must have at least `v2.0.49`, which you can verify with `az --version` command.
1514

16-
1. [Install the Azure CLI](https://docs.microsoft.com/cli/azure/install-azure-cli).
17-
You must have at least `v2.0.49`, which you can verify with `az --version` command.
18-
2. Add the Azure DevOps Extension
19-
`az extension add --name azure-devops`
20-
3. Run the `az login` command.
15+
1. Add the Azure DevOps Extension `az extension add --name azure-devops`
2116

22-
If the CLI can open your default browser, it will do so and load a sign-in page.
23-
Otherwise, you need to open a browser page and follow the instructions on the command line to enter an authorization code after navigating to https://aka.ms/devicelogin in your browser. For more information, see the [Azure CLI login page](https://docs.microsoft.com/cli/azure/authenticate-azure-cli?view=azure-cli-latest).
17+
1. Run the `az login` command.
2418

25-
See the [Get started guide](/doc/getting_started.md) for detailed setup instructions.
19+
If the CLI can open your default browser, it will do so and load a sign-in page. Otherwise, you need to open a
20+
browser page and follow the instructions on the command line to enter an authorization code after navigating to
21+
[https://aka.ms/devicelogin](https://aka.ms/devicelogin) in your browser. For more information, see the
22+
[Azure CLI login page](https://docs.microsoft.com/cli/azure/authenticate-azure-cli?view=azure-cli-latest).
2623

27-
# Usage
28-
```
24+
See the [Get started guide](/doc/getting_started.md) for detailed setup instructions.
25+
26+
## Usage
27+
28+
```bash
2929
$az [group] [subgroup] [command] {parameters}
3030
```
31+
3132
Adding the Azure DevOps Extension adds `devops`, `pipelines`, `artifacts`, `boards` and `repos` groups.
3233
For usage and help content for any command, pass in the -h parameter, for example:
33-
```
34+
35+
```bash
3436
$az devops -h
35-
```
36-
```
37+
3738
Command
3839
az devops configure: Configure the Azure DevOps CLI or view your configuration.
39-
40+
4041
Arguments
4142
--defaults -d : Space separated 'name=value' pairs for common arguments defaults, e.g. '--
42-
defaults project=my-project-name organization=https://dev.azure.com/organizationName arg=value' Use '' to
43+
defaults project=my-project-name organization=https://dev.azure.com/organizationName arg=value' Use '' to
4344
clear the defaults, e.g. --defaults project=''.
4445
-- list -l : Lists the contents of the config file.
45-
--use-git-aliases : Set to 'yes' to configure Git aliiases global git config file (to enable
46+
--use-git-aliases : Set to 'yes' to configure Git aliiases global git config file (to enable
4647
commands like "git pr list"). Set to 'no' to remove any aliases set by the
4748
tool. Allowed values: no, yes.
4849

@@ -53,13 +54,15 @@ Global Arguments
5354
--query : JMESPath query string. See http://jmespath.org/ for more information and examples.
5455
--subscription : Name or ID of subscription. You can configure the default subscription using 'az account set -s NAME_OR_ID'
5556
--verbose : Increase logging verbosity. Use --debug for full debug logs.
56-
5757
```
58-
- Documentation for all the commands is available at [Microsoft Azure CLI Docs - Azure DevOps](https://docs.microsoft.com/cli/azure/ext/azure-devops/?view=azure-cli-latest).
58+
59+
- Documentation for all the commands is available at [Microsoft Azure CLI Docs - Azure DevOps](https://docs.microsoft.com/cli/azure/ext/azure-devops/?view=azure-cli-latest).
5960
- Check out other examples in the [samples](/doc/samples.md) section.
6061

61-
# Contribute
62+
## Contribute
63+
6264
See our [contribution guidelines](CONTRIBUTING.md) to learn how you can contribute to this project.
6365

64-
# License
66+
## License
67+
6568
[MIT License](LICENSE)

‎doc/authoring_tests.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22

33
Make sure your machine python SDK cache is clear
44

5-
It is located at
6-
%userprofile%\.vsts\python-sdk\cache\
5+
It is located at `%userprofile%\.vsts\python-sdk\cache\`
76

87
While running the test localy for first time make sure that the cassest (in the recording folder) gets the resource call as well
98

109
Before commiting the code make sure to randomize the PAT token
1110

12-
# Known issues
13-
In case you run into error where the size of response is too large to be recorded
11+
## Known issues
12+
13+
In case you run into error where the size of response is too large to be recorded
1414
you can use this decorator on top of the test case
1515
@AllowLargeResponse(size_kb=3072)
1616

17-
# Points to remember
18-
-Actual Test Setup/ Environment should be kept intact (i.e. maintained)
19-
so that if someone new wants to re-run and re-record the test case (with a proper PAT token) then
20-
they should be able to
17+
## Points to remember
18+
19+
- Actual Test Setup/ Environment should be kept intact (i.e. maintained) so that if someone new wants to re-run and
20+
re-record the test case (with a proper PAT token) then they should be able to

‎doc/command_mapping.md

+55-55
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,55 @@
1-
# Command Mapping
2-
3-
The following table provides the mapping of commands from VSTS CLI to Azure DevOps Extension.
4-
5-
|VSTS CLI|Azure DevOps Extension|
6-
|---|---|
7-
|`vsts configure`|`az devops configure`|
8-
|`vsts feedback`|`az feedback`|
9-
|`vsts login`|`az login` <br> `az devops login` (for PAT)|
10-
|`vsts logout`|`az logout` <br> `az devops logout` (for PAT)|
11-
|`vsts admin banner add`|`az devops admin banner add`|
12-
|`vsts admin banner list`|`az devops admin banner list`|
13-
|`vsts admin banner remove`|`az devops admin banner remove`|
14-
|`vsts admin banner show`|`az devops admin banner show`|
15-
|`vsts admin banner update`|`az devops admin banner update`|
16-
|`vsts build list`|`az pipelines build list`|
17-
|`vsts build queue`|`az pipelines build queue`|
18-
|`vsts build show`|`az pipelines build show`|
19-
|`vsts build definition list`|`az pipelines build definition list`|
20-
|`vsts build definition show`|`az pipelines build definition show`|
21-
|`vsts build task list`|`az pipelines build task list`|
22-
|`vsts build task show`|`az pipelines build task show`|
23-
|`vsts code pr abandon`|`az repos pr abandon`|
24-
|`vsts code pr complete`|`az repos pr complete`|
25-
|`vsts code pr create`|`az repos pr create`|
26-
|`vsts code pr list`|`az repos pr list`|
27-
|`vsts code pr reactivate`|`az repos pr reactivate`|
28-
|`vsts code pr set-vote`|`az repos pr set-vote`|
29-
|`vsts code pr show`|`az repos pr show`|
30-
|`vsts code pr update`|`az repos pr update`|
31-
|`vsts code pr policies list`|`az repos pr policies list`|
32-
|`vsts code pr policies queue`|`az repos pr policies queue`|
33-
|`vsts code pr reviewers add`|`az repos pr reviewers add`|
34-
|`vsts code pr reviewers list`|`az repos pr reviewers list`|
35-
|`vsts code pr reviewers remove`|`az repos pr reviewers remove`|
36-
|`vsts code pr work-items add`|`az repos pr work-items add`|
37-
|`vsts code pr work-items list`|`az repos pr work-items list`|
38-
|`vsts code pr work-items remove`|`az repos pr work-items remove`|
39-
|`vsts code repo create`|`az repos create`|
40-
|`vsts code repo list`|`az repos list`|
41-
|`vsts code repo show`|`az repos show`|
42-
|`vsts package universal download`|`az artifacts universal download`|
43-
|`vsts package universal publish`|`az artifacts universal publish`|
44-
|`vsts project create`|`az devops project create`|
45-
|`vsts project list`|`az devops project list`|
46-
|`vsts project show`|`az devops project show`|
47-
|`vsts release list`|`az pipelines release list`|
48-
|`vsts release create`|`az pipelines release create`|
49-
|`vsts release show`|`az pipelines release show`|
50-
|`vsts release definition list`|`az pipelines release definition list`|
51-
|`vsts release definition show`|`az pipelines release definition show`|
52-
|`vsts work item create`|`az boards work-item create`|
53-
|`vsts work item show`|`az boards work-item show`|
54-
|`vsts work item update`|`az boards work-item update`|
55-
|`vsts work item query`|`az boards query`|
1+
# Command Mapping
2+
3+
The following table provides the mapping of commands from VSTS CLI to Azure DevOps Extension.
4+
5+
|VSTS CLI|Azure DevOps Extension|
6+
|---|---|
7+
|`vsts configure`|`az devops configure`|
8+
|`vsts feedback`|`az feedback`|
9+
|`vsts login`|`az login` <br> `az devops login` (for PAT)|
10+
|`vsts logout`|`az logout` <br> `az devops logout` (for PAT)|
11+
|`vsts admin banner add`|`az devops admin banner add`|
12+
|`vsts admin banner list`|`az devops admin banner list`|
13+
|`vsts admin banner remove`|`az devops admin banner remove`|
14+
|`vsts admin banner show`|`az devops admin banner show`|
15+
|`vsts admin banner update`|`az devops admin banner update`|
16+
|`vsts build list`|`az pipelines build list`|
17+
|`vsts build queue`|`az pipelines build queue`|
18+
|`vsts build show`|`az pipelines build show`|
19+
|`vsts build definition list`|`az pipelines build definition list`|
20+
|`vsts build definition show`|`az pipelines build definition show`|
21+
|`vsts build task list`|`az pipelines build task list`|
22+
|`vsts build task show`|`az pipelines build task show`|
23+
|`vsts code pr abandon`|`az repos pr abandon`|
24+
|`vsts code pr complete`|`az repos pr complete`|
25+
|`vsts code pr create`|`az repos pr create`|
26+
|`vsts code pr list`|`az repos pr list`|
27+
|`vsts code pr reactivate`|`az repos pr reactivate`|
28+
|`vsts code pr set-vote`|`az repos pr set-vote`|
29+
|`vsts code pr show`|`az repos pr show`|
30+
|`vsts code pr update`|`az repos pr update`|
31+
|`vsts code pr policies list`|`az repos pr policies list`|
32+
|`vsts code pr policies queue`|`az repos pr policies queue`|
33+
|`vsts code pr reviewers add`|`az repos pr reviewers add`|
34+
|`vsts code pr reviewers list`|`az repos pr reviewers list`|
35+
|`vsts code pr reviewers remove`|`az repos pr reviewers remove`|
36+
|`vsts code pr work-items add`|`az repos pr work-items add`|
37+
|`vsts code pr work-items list`|`az repos pr work-items list`|
38+
|`vsts code pr work-items remove`|`az repos pr work-items remove`|
39+
|`vsts code repo create`|`az repos create`|
40+
|`vsts code repo list`|`az repos list`|
41+
|`vsts code repo show`|`az repos show`|
42+
|`vsts package universal download`|`az artifacts universal download`|
43+
|`vsts package universal publish`|`az artifacts universal publish`|
44+
|`vsts project create`|`az devops project create`|
45+
|`vsts project list`|`az devops project list`|
46+
|`vsts project show`|`az devops project show`|
47+
|`vsts release list`|`az pipelines release list`|
48+
|`vsts release create`|`az pipelines release create`|
49+
|`vsts release show`|`az pipelines release show`|
50+
|`vsts release definition list`|`az pipelines release definition list`|
51+
|`vsts release definition show`|`az pipelines release definition show`|
52+
|`vsts work item create`|`az boards work-item create`|
53+
|`vsts work item show`|`az boards work-item show`|
54+
|`vsts work item update`|`az boards work-item update`|
55+
|`vsts work item query`|`az boards query`|

0 commit comments

Comments
 (0)