Skip to content

Commit 4725910

Browse files
author
damccorm
authored
Update links and string in documents from rebranding (#457)
* Update references to vsts-task-lib to azure-pipelines-task-lib * Rename files in node docs * Keep capitalization consistent in headings * Bump patch version * Don't need patch bump for powershell Only docs were changed.
1 parent 6036725 commit 4725910

33 files changed

+111
-111
lines changed

‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ A task which automates Powershell technologies can be written with our Powershel
4141
Documentation: [PowerShell API](powershell/Docs/README.md)
4242

4343

44-
[npm-lib-image]: https://img.shields.io/npm/v/vsts-task-lib.svg?style=flat
45-
[npm-lib-url]: https://www.npmjs.com/package/vsts-task-lib
44+
[npm-lib-image]: https://img.shields.io/npm/v/azure-pipelines-task-lib.svg?style=flat
45+
[npm-lib-url]: https://www.npmjs.com/package/azure-pipelines-task-lib
4646
[npm-sdk-image]: https://img.shields.io/npm/v/vsts-task-sdk.svg?style=flat
4747
[npm-sdk-url]: https://www.npmjs.com/package/vsts-task-sdk

‎azure-pipelines.yml

+18-18
Original file line numberDiff line numberDiff line change
@@ -12,35 +12,35 @@ jobs:
1212

1313
steps:
1414
################################################################################
15-
# vsts-task-lib
15+
# azure-pipelines-task-lib
1616
################################################################################
1717

1818
# npm install
1919
- task: Npm@1
20-
displayName: (vsts-task-lib) npm install
20+
displayName: (azure-pipelines-task-lib) npm install
2121
inputs:
2222
command: install
2323
workingDir: node
2424

2525
# use node 5
2626
- powershell: |
2727
& "$(build.sourcesDirectory)/res/UseNode5.ps1"
28-
displayName: (vsts-task-lib) use node 5.10.1
28+
displayName: (azure-pipelines-task-lib) use node 5.10.1
2929
3030
# build/test
3131
- script: node make.js test
3232
workingDirectory: node
33-
displayName: (vsts-task-lib) node make.js test
33+
displayName: (azure-pipelines-task-lib) node make.js test
3434

3535
# use node 6
3636
- task: NodeTool@0
37-
displayName: (vsts-task-lib) use node 6.10.3
37+
displayName: (azure-pipelines-task-lib) use node 6.10.3
3838
inputs:
3939
versionSpec: "6.10.3"
4040

4141
# build/test
4242
- script: node make.js test
43-
displayName: (vsts-task-lib) node make.js test
43+
displayName: (azure-pipelines-task-lib) node make.js test
4444
workingDirectory: node
4545

4646
################################################################################
@@ -68,36 +68,36 @@ jobs:
6868

6969
steps:
7070
################################################################################
71-
# vsts-task-lib
71+
# azure-pipelines-task-lib
7272
################################################################################
7373

7474
# npm install
7575
- task: Npm@1
76-
displayName: (vsts-task-lib) npm install
76+
displayName: (azure-pipelines-task-lib) npm install
7777
inputs:
7878
command: install
7979
workingDir: node
8080

8181
# use node 5
8282
- task: NodeTool@0
83-
displayName: (vsts-task-lib) use node 5.10.1
83+
displayName: (azure-pipelines-task-lib) use node 5.10.1
8484
inputs:
8585
versionSpec: "5.10.1"
8686

8787
# build/test
8888
- script: node make.js test
8989
workingDirectory: node
90-
displayName: (vsts-task-lib) node make.js test
90+
displayName: (azure-pipelines-task-lib) node make.js test
9191

9292
# use node 6
9393
- task: NodeTool@0
94-
displayName: (vsts-task-lib) use node 6.10.3
94+
displayName: (azure-pipelines-task-lib) use node 6.10.3
9595
inputs:
9696
versionSpec: "6.10.3"
9797

9898
# build/test
9999
- script: node make.js test
100-
displayName: (vsts-task-lib) node make.js test
100+
displayName: (azure-pipelines-task-lib) node make.js test
101101
workingDirectory: node
102102

103103
#################################################
@@ -109,34 +109,34 @@ jobs:
109109

110110
steps:
111111
################################################################################
112-
# vsts-task-lib
112+
# azure-pipelines-task-lib
113113
################################################################################
114114

115115
# npm install
116116
- task: Npm@1
117-
displayName: (vsts-task-lib) npm install
117+
displayName: (azure-pipelines-task-lib) npm install
118118
inputs:
119119
command: install
120120
workingDir: node
121121

122122
# use node 5
123123
- task: NodeTool@0
124-
displayName: (vsts-task-lib) use node 5.10.1
124+
displayName: (azure-pipelines-task-lib) use node 5.10.1
125125
inputs:
126126
versionSpec: "5.10.1"
127127

128128
# build/test
129129
- script: node make.js test
130130
workingDirectory: node
131-
displayName: (vsts-task-lib) node make.js test
131+
displayName: (azure-pipelines-task-lib) node make.js test
132132

133133
# use node 6
134134
- task: NodeTool@0
135-
displayName: (vsts-task-lib) use node 6.10.3
135+
displayName: (azure-pipelines-task-lib) use node 6.10.3
136136
inputs:
137137
versionSpec: "6.10.3"
138138

139139
# build/test
140140
- script: node make.js test
141-
displayName: (vsts-task-lib) node make.js test
141+
displayName: (azure-pipelines-task-lib) node make.js test
142142
workingDirectory: node

‎node/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Cross platform tasks are written in TypeScript. It is the preferred way to writ
1515

1616
Step by Step: [Create Task](docs/stepbystep.md)
1717

18-
Documentation: [TypeScript API](docs/vsts-task-lib.md), [task JSON schema](https://aka.ms/vsts-tasks.schema.json)
18+
Documentation: [TypeScript API](docs/azure-pipelines-task-lib.md), [task JSON schema](https://aka.ms/vsts-tasks.schema.json)
1919

2020
Guidance: [Finding Files](docs/findingfiles.md), [Minimum agent version](docs/minagent.md), [Proxy](docs/proxy.md), [Certificate](docs/cert.md)
2121

@@ -40,8 +40,8 @@ $ npm test
4040

4141
Set environment variable TASK_TEST_TRACE=1 to display test output.
4242

43-
[npm-lib-image]: https://img.shields.io/npm/v/vsts-task-lib.svg?style=flat
44-
[npm-lib-url]: https://www.npmjs.com/package/vsts-task-lib
43+
[npm-lib-image]: https://img.shields.io/npm/v/azure-pipelines-task-lib.svg?style=flat
44+
[npm-lib-url]: https://www.npmjs.com/package/azure-pipelines-task-lib
4545

4646
## Third Party Notices
4747
To generate/update third party notice file run:

‎node/ThirdPartyNotice.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
THIRD-PARTY SOFTWARE NOTICES AND INFORMATION
33
Do Not Translate or Localize
44

5-
This Visual Studio Team Services extension (vsts-task-lib) is based on or incorporates material from the projects listed below (Third Party IP). The original copyright notice and the license under which Microsoft received such Third Party IP, are set forth below. Such licenses and notices are provided for informational purposes only. Microsoft licenses the Third Party IP to you under the licensing terms for the Visual Studio Team Services extension. Microsoft reserves all other rights not expressly granted under this agreement, whether by implication, estoppel or otherwise.
5+
This Azure Pipelines extension (azure-pipelines-task-lib) is based on or incorporates material from the projects listed below (Third Party IP). The original copyright notice and the license under which Microsoft received such Third Party IP, are set forth below. Such licenses and notices are provided for informational purposes only. Microsoft licenses the Third Party IP to you under the licensing terms for the Visual Studio Team Services extension. Microsoft reserves all other rights not expressly granted under this agreement, whether by implication, estoppel or otherwise.
66

77
1. asap (git+https://github.com/kriskowal/asap.git)
88
2. balanced-match (git://github.com/juliangruber/balanced-match.git)

‎node/dependencies/typings.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "vsts-task-lib",
2+
"name": "azure-pipelines-task-lib",
33
"main": "task.d.ts",
44
"globalDependencies": {
55
"node": "registry:dt/node#6.0.0+20160709114037",

‎node/docs/vsts-task-lib.json renamed to ‎node/docs/azure-pipelines-task-lib.json

File renamed without changes.

‎node/docs/vsts-task-lib.md renamed to ‎node/docs/azure-pipelines-task-lib.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
# VSTS-TASK-LIB TYPESCRIPT API
1+
# AZURE-PIPELINES-TASK-LIB TYPESCRIPT API
22

33
## Dependencies
44
A [cross platform agent](https://github.com/Microsoft/vso-agent) OR a TFS 2015 Update 2 Windows agent (or higher) is required to run a Node task end-to-end. However, an agent is not required for interactively testing the task.
55

66
## Importing
7-
For now, the built vsts-task-lib (in _build) should be packaged with your task in a node_modules folder
7+
For now, the built azure-pipelines-task-lib (in _build) should be packaged with your task in a node_modules folder
88

9-
The build generates a vsts-task-lib.d.ts file for use when compiling tasks
9+
The build generates a azure-pipelines-task-lib.d.ts file for use when compiling tasks
1010
In the example below, it is in a folder named definitions above the tasks lib
1111

1212
```
13-
/// <reference path="../definitions/vsts-task-lib.d.ts" />
14-
import tl = require('vsts-task-lib/task')
13+
/// <reference path="../definitions/azure-pipelines-task-lib.d.ts" />
14+
import tl = require('azure-pipelines-task-lib/task')
1515
```
1616

1717
## [Release notes](releases.md)
@@ -311,9 +311,9 @@ secret | boolean | whether variable is secret. optional, defaults to false
311311
Tasks typically execute a series of tools (cli) and set the result of the task based on the outcome of those
312312

313313
```javascript
314-
/// <reference path="../definitions/vsts-task-lib.d.ts" />
315-
import tl = require('vsts-task-lib/task');
316-
import tr = require('vsts-task-lib/toolrunner');
314+
/// <reference path="../definitions/azure-pipelines-task-lib.d.ts" />
315+
import tl = require('azure-pipelines-task-lib/task');
316+
import tr = require('azure-pipelines-task-lib/toolrunner');
317317

318318
try {
319319
var toolPath = tl.which('atool');
@@ -1035,7 +1035,7 @@ includeDirectories | boolean | whether to include directories in the result
10351035
Localization is optional but is supported using these functions at runtime
10361036

10371037
```javascript
1038-
/// <reference path="../definitions/vsts-task-lib.d.ts" />
1038+
/// <reference path="../definitions/azure-pipelines-task-lib.d.ts" />
10391039

10401040
tl.setResourcePath(path.join( __dirname, 'task.json'));
10411041

‎node/docs/findingfiles.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,19 @@ When designing a task glob input experience, one of the following UI layout patt
1616

1717
## Task Lib Functions
1818

19-
The above UI experiences translate to one of the following consumption patterns of the [task lib API](vsts-task-lib.md):
19+
The above UI experiences translate to one of the following consumption patterns of the [task lib API](azure-pipelines-task-lib.md):
2020

2121
1. `filePath` input only
22-
- Call [findMatch](vsts-task-lib.md#taskfindMatch) and pass the filePath input as the pattern.
22+
- Call [findMatch](azure-pipelines-task-lib.md#taskfindMatch) and pass the filePath input as the pattern.
2323

2424
2. `filePath` input to specify a root directory, followed by a `multiLine` input for match patterns.
25-
- Call [find](vsts-task-lib.md#taskfind) to recursively find all paths under the specified root directory.
26-
- Then call [match](vsts-task-lib.md#taskmatch) to filter the results using the multiLine input as the patterns.
25+
- Call [find](azure-pipelines-task-lib.md#taskfind) to recursively find all paths under the specified root directory.
26+
- Then call [match](azure-pipelines-task-lib.md#taskmatch) to filter the results using the multiLine input as the patterns.
2727

2828
3. `filePath` input to specify a *default* root directory to root any unrooted patterns, followed by a `multiLine` input for match patterns.
29-
- Call [findMatch](vsts-task-lib.md#taskfindMatch) and pass the filePath input as the defaultRoot and the multiLine input as the patterns.
29+
- Call [findMatch](azure-pipelines-task-lib.md#taskfindMatch) and pass the filePath input as the defaultRoot and the multiLine input as the patterns.
3030

31-
Note, use [getDelimitedInput](vsts-task-lib.md#taskgetDelimitedInput) to split a multiLine input using the delimiter `'\n'`.
31+
Note, use [getDelimitedInput](azure-pipelines-task-lib.md#taskgetDelimitedInput) to split a multiLine input using the delimiter `'\n'`.
3232

3333
## Recommended FindOptions and MatchOptions
3434

‎node/docs/gendocs.ts

+7-7
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ let options: ts.CompilerOptions = {
2020
target: srcOptions['target']
2121
}
2222

23-
const jsonDocName: string = "vsts-task-lib.json";
24-
const mdDocName: string = "vsts-task-lib.md";
23+
const jsonDocName: string = "azure-pipelines-task-lib.json";
24+
const mdDocName: string = "azure-pipelines-task-lib.md";
2525

2626
header('Generating ' + jsonDocName);
2727
let doc: ts2json.DocEntry = ts2json.generate(docs.files, options);
@@ -155,20 +155,20 @@ var writeInterface = function(name: string, item: ts2json.DocEntry) {
155155
writeLine();
156156
}
157157

158-
writeLine('# VSTS-TASK-LIB TYPESCRIPT API');
158+
writeLine('# AZURE-DEVOPS-TASK-LIB TYPESCRIPT API');
159159
writeLine();
160160
writeLine('## Dependencies');
161161
writeLine('A [cross platform agent](https://github.com/Microsoft/vso-agent) OR a TFS 2015 Update 2 Windows agent (or higher) is required to run a Node task end-to-end. However, an agent is not required for interactively testing the task.');
162162
writeLine();
163163
writeLine('## Importing');
164-
writeLine('For now, the built vsts-task-lib (in _build) should be packaged with your task in a node_modules folder');
164+
writeLine('For now, the built azure-pipelines-task-lib (in _build) should be packaged with your task in a node_modules folder');
165165
writeLine();
166-
writeLine('The build generates a vsts-task-lib.d.ts file for use when compiling tasks');
166+
writeLine('The build generates a azure-pipelines-task-lib.d.ts file for use when compiling tasks');
167167
writeLine('In the example below, it is in a folder named definitions above the tasks lib');
168168
writeLine();
169169
writeLine('```');
170-
writeLine('/// <reference path="../definitions/vsts-task-lib.d.ts" />');
171-
writeLine("import tl = require('vsts-task-lib/task')");
170+
writeLine('/// <reference path="../definitions/azure-pipelines-task-lib.d.ts" />');
171+
writeLine("import tl = require('azure-pipelines-task-lib/task')");
172172
writeLine('```');
173173
writeLine();
174174
writeLine('## [Release notes](releases.md)');

‎node/docs/proxy.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### Get proxy configuration by using [VSTS-Task-Lib](https://github.com/Microsoft/vsts-task-lib) method
1+
### Get proxy configuration by using [AZURE-DEVOPS-TASK-LIB](https://github.com/Microsoft/azure-pipelines-task-lib) method
22

33
#### Node.js Lib
44

@@ -20,7 +20,7 @@ export interface ProxyConfiguration {
2020
In the following example, we will retrieve proxy configuration information and use VSTS-Node-Api to make a Rest Api call back to VSTS/TFS service, the Rest call will go through the web proxy you configured in `.proxy` file.
2121
```typescript
2222
// MyProxyExampleTask.ts
23-
import tl = require('vsts-task-lib/task');
23+
import tl = require('azure-pipelines-task-lib/task');
2424
import api = require('vso-node-api');
2525
import VsoBaseInterfaces = require('vso-node-api/interfaces/common/VsoBaseInterfaces');
2626

@@ -39,7 +39,7 @@ async function run() {
3939
// Options for VSTS-Node-Api,
4040
// this is not required if you want to send http request to the same VSTS/TFS
4141
// instance the agent currently connect to.
42-
// VSTS-Node-Api will pick up proxy setting from VSTS-Task-Lib automatically
42+
// VSTS-Node-Api will pick up proxy setting from azure-pipelines-task-lib automatically
4343
let option: VsoBaseInterfaces.IRequestOptions = {
4444
proxy: {
4545
proxyUrl: proxy.proxyUrl,

‎node/docs/releases.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# VSTS-TASK-LIB RELEASES
1+
# AZURE-PIPELINES-TASK-LIB RELEASES
22

33
## 2.7.0
44
* Updated `setResult` to expose optional done parameter

‎node/docs/samples/loc.src

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
/// <reference path="../definitions/vsts-task-lib.d.ts" />
1+
/// <reference path="../definitions/azure-pipelines-task-lib.d.ts" />
22

33
tl.setResourcePath(path.join( __dirname, 'task.json'));
44

‎node/docs/samples/toolrunner.src

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
/// <reference path="../definitions/vsts-task-lib.d.ts" />
2-
import tl = require('vsts-task-lib/task');
3-
import tr = require('vsts-task-lib/toolrunner');
1+
/// <reference path="../definitions/azure-pipelines-task-lib.d.ts" />
2+
import tl = require('azure-pipelines-task-lib/task');
3+
import tr = require('azure-pipelines-task-lib/toolrunner');
44

55
try {
66
var toolPath = tl.which('atool');

‎node/docs/stepbystep.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -39,18 +39,18 @@ $ mkdir sampletask && cd sampletask
3939
$ npm init
4040
```
4141

42-
### Add vsts-task-lib
42+
### Add azure-pipelines-task-lib
4343

44-
Add vsts-task-lib to your task. Remember your task must carry the lib. Ensure it's at least 0.9.5 which now carries typings.
44+
Add azure-pipelines-task-lib to your task. Remember your task must carry the lib. Ensure it's at least 0.9.5 which now carries typings.
4545

4646
The package.json should have dependency with ^. Ex: ^0.9.5. This means you are locked to 0.9.x and will pick up patches on npm install.
4747

4848
The npm module carries the .d.ts typecript definition files so compile and intellisense support will just work.
4949

5050
```
51-
$ npm install vsts-task-lib --save
51+
$ npm install azure-pipelines-task-lib --save
5252
...
53-
└─┬ vsts-task-lib@2.0.5
53+
└─┬ azure-pipelines-task-lib@2.0.5
5454
...
5555
```
5656

@@ -95,8 +95,8 @@ Instellisense should just work in [VS Code](https://code.visualstudio.com)
9595
The code is straight forward. As a reference:
9696

9797
```javascript
98-
import tl = require('vsts-task-lib/task');
99-
import trm = require('vsts-task-lib/toolrunner');
98+
import tl = require('azure-pipelines-task-lib/task');
99+
import trm = require('azure-pipelines-task-lib/toolrunner');
100100
import mod = require('./taskmod');
101101

102102
async function run() {
@@ -145,7 +145,7 @@ Key Points:
145145
- Never process.exit your task. You can sometimes lose output and often the last bit of output is critical
146146

147147
If we did our job well, the code should be pretty self explanatory.
148-
But, see the [API Reference](vsts-task-lib.md) for specifics.
148+
But, see the [API Reference](azure-pipelines-task-lib.md) for specifics.
149149

150150
## Compile
151151

@@ -228,7 +228,7 @@ Node offers an interactive console and since the task lib is in your node_module
228228

229229
```bash
230230
$ node
231-
> var tl = require('vsts-task-lib/task');
231+
> var tl = require('azure-pipelines-task-lib/task');
232232
##vso[task.debug]agent.workFolder=undefined
233233
##vso[task.debug]loading inputs and endpoints
234234
##vso[task.debug]loaded 0
@@ -248,7 +248,7 @@ Coming soon
248248

249249
## Unit testing your task scripts
250250

251-
This requires vsts-task-lib 0.9.15 or greater.
251+
This requires azure-pipelines-task-lib 0.9.15 or greater.
252252

253253

254254
### Goals:

‎node/generate-third-party-notice.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ function main(args) {
159159
const licenseInfo = Array.from(collectLicenseInfo(nodeModuleDir));
160160

161161
const writeStream = fs.createWriteStream(path.join(__dirname, 'ThirdPartyNotice.txt'));
162-
writeLines(writeStream, thirdPartyNotice('vsts-task-lib', licenseInfo));
162+
writeLines(writeStream, thirdPartyNotice('azure-pipelines-task-lib', licenseInfo));
163163
writeStream.end();
164164
} catch (e) {
165165
log.error(e.message);

0 commit comments

Comments
 (0)