vsts_create_release: Azure DevOps Project Release Information

Description Usage Arguments Details Examples

View source: R/release.R

Description

These functions will allow you to create releases from Azure DevOps.

Usage

1
vsts_create_release(domain, project, auth_key, body)

Arguments

domain

The name of the Azure DevOps organization.

project

the name of the project in domain to look at

auth_key

authentication key generated by using vsts_auth_key

body

a list of extra parameters that can need to be sent to the API call (* mandatory):

artifacts *

[list] Sets list of artifact to create a release. Check Details for more information.

definitionId *

[integer] Sets definition Id to create a release.

description *

[character] Sets description to create a release.

isDraft

[logical] Sets 'true' to create release in draft mode, 'false' otherwise.

manualEnvironments

[character] Sets list of environments to manual as condition.

properties

[list] The class represents a property bag as a collection of key-value pairs.

reason

[character] Sets reason to create a release.

Details

The artifacts object within the body contains two items:

For more information about release API calls check https://docs.microsoft.com/en-us/rest/api/vsts/release/releases.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
## Not run: 
# Add in own details to get a non-NULL output
auth_key <- vsts_auth_key("<username>", "<password>")
art_list <- list(
  list(alias = "Art1", instanceReference = list(id = 1)),
  list(alias = "Art2", instanceReference = list(id = 2))
)
body <- list(
  definitionId = 1, description = "R API Release",
  artifacts = I(art_list)
)
vsts_create_release("domain", "project", auth_key, body)

## End(Not run)

vstsr documentation built on Nov. 9, 2021, 1:07 a.m.