Azure DevOps Account

Description

Azure DevOps Account

Arguments

Format

An R6Class generator object

Details

For the majority of functions that are within this vsts_account object, you can get help about the query or body parameter with ?vsts_<function name>.

Examples

## Not run: 
proj <- vsts_account$new(
  "<username>", "<password>", "<domain>",
  "<project>", "<repo>"
)
str(proj)

## End(Not run)

Azure DevOps Authentication Key

Description

Creation of a Azure DevOps authentication key that will be used when running any of the API calls.

Usage

vsts_auth_key(user, pass)

Arguments

Details

For more information about authentication check https://docs.microsoft.com/en-us/rest/api/azure/devops/?view=azure-devops-rest-6.1#create-the-request

Value

An authentication key string in the form of 'Basic <Base 64 of user:pass>'

Examples

# Using credentials
auth_key <- vsts_auth_key("<username>", "<password>")

# Using PAT token
auth_key <- vsts_auth_key(NULL, "<token>")

Azure DevOps Project Release Information

Description

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

Usage

vsts_create_release(domain, project, auth_key, body)

Arguments

Details

The artifacts object within the body contains two items:

• alias[character] Sets alias of artifact.

• instanceReference[list] Sets instance reference of artifact. e.g. for build artifact it is build number.

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

Examples

## 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)

Azure DevOps Project Work Items

Description

These functions will allow you to scrape work item information from a particular Azure DevOps project.

Usage

vsts_create_workitem(domain, project, item_type, auth_key, ...)

Arguments

Details

For more information about work item API calls check https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/work-items.

Azure DevOps Project Release Environment Information

Description

These functions will allow you to run release environment tasks from Azure DevOps.

Usage

vsts_deploy_release(domain, project, release, env, auth_key)

Arguments

Details

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

Examples

## Not run: 
# Add in own details to get a non-NULL output
auth_key <- vsts_auth_key("<username>", "<password>")
vsts_deploy_release("domain", "project", auth_key, 1, 1)

## End(Not run)

Azure DevOps Project Build Definition Information

Description

These functions will allow you to scrape build definition information from Azure DevOps.

Usage

vsts_get_build_defs(domain, project, auth_key, query = NULL)

Arguments

Details

For more information about the build definition API calls check https://docs.microsoft.com/en-us/rest/api/azure/devops/build/definitions/list.

Examples

## Not run: 
# Add in own details to get a non-NULL output
auth_key <- vsts_auth_key("<username>", "<password>")
vsts_get_build_defs("domain", "project", auth_key)

## End(Not run)

Azure DevOps Project Git Repositories

Description

These functions will allow you to scrape git repository information from Azure DevOps.

Usage

vsts_get_commits(domain, project, repo, auth_key, query = NULL)

Arguments

Details

For more information about git repository API calls check https://docs.microsoft.com/en-us/rest/api/azure/devops/git/commits/get-commits.

Examples

## Not run: 
# Add in own details to get a non-NULL output
auth_key <- vsts_auth_key("<username>", "<password>")
vsts_get_commits("domain", "project", "repo", auth_key)

## End(Not run)

Azure DevOps Projects

Description

These functions will allow you to scrape project information from Azure DevOps.

Usage

vsts_get_projects(domain, auth_key, quiet = FALSE)

Arguments

Details

For more information about project API calls check https://docs.microsoft.com/en-us/rest/api/azure/devops/core/Projects.

Azure DevOps Project Release Definition Information

Description

These functions will allow you to scrape release definition information from Azure DevOps.

Usage

vsts_get_release_defs(domain, project, auth_key, quiet = FALSE)

Arguments

Details

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

Examples

## Not run: 
# Add in own details to get a non-NULL output
auth_key <- vsts_auth_key("<username>", "<password>")
vsts_get_release_defs("domain", "project", auth_key)

## End(Not run)

Azure DevOps Project Release Information

Description

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

Usage

vsts_get_releases(domain, project, auth_key, query = NULL)

vsts_get_release(domain, project, release, auth_key)

Arguments

Details

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

Examples

## Not run: 
# Add in own details to get a non-NULL output
auth_key <- vsts_auth_key("<username>", "<password>")
vsts_get_releases("domain", "project", auth_key)

## End(Not run)

Azure DevOps Project Repositories

Description

These functions will allow you to scrape project information from Azure DevOps.

Usage

vsts_get_repos(domain, project, auth_key, quiet = FALSE)

vsts_create_repo(domain, project, repo, auth_key, quiet = FALSE)

vsts_delete_repo(domain, project, repo, auth_key, quiet = FALSE)

Arguments

Details

For more information about repository API calls check https://docs.microsoft.com/en-us/rest/api/azure/devops/git.

Examples

## Not run: 
# Add in own details to get a non-NULL output
auth_key <- vsts_auth_key("<username>", "<password>")

# Get repo list
vsts_get_repos("domain", "project", auth_key)

# Create new repo
vsts_create_repo("domain", "project", "repo", auth_key)

# Delete existing repo
vsts_delete_repo("domain", "project", "repo", auth_key)

## End(Not run)

Azure DevOps Work Item Fields

Description

This contains all the fields required of any work item in a visual studio project and helps add/rename the fields of the selected work item.

Usage

vsts_get_workitem_fields(
  System.Title,
  System.Description,
  System.TeamProject,
  System.AreaPath,
  System.IterationPath,
  Microsoft.VSTS.Common.Priority,
  ...
)

Arguments

Details

For more information about work item fields API calls check https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/Fields.

Azure DevOps Project Get Work Items

Description

These functions will allow you to scrape work item information from a particular Azure DevOps project.

Usage

vsts_get_workitems(domain, project, auth_key, id, query = list())

vsts_get_workitem(domain, project, auth_key, id)

Arguments

Details

For more information about work item API calls check https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/work-items.

Azure DevOps Custom API Calls

Description

For any requirement not currently in place in the vstsr package, then this function will allow you to use the relevant API call without any extra requirements.

For the most part it is just a shell of VERB but will have the auth_key set up already.

Usage

vsts_run_command(url, verb, auth_key, body = NULL, query = NULL)

Arguments

Examples

## Not run: 
auth_key <- vsts_auth_key("<username>", "<password>")
# Get commits of a repository
URL <- file.path(
  "https://dev.azure.com",
  domain,
  project,
  "_apis/git/repositories",
  repository_id,
  "commits?api-version=5.0"
)
vsts_run_command(URL, "GET", auth_key)

## End(Not run)

vstsr: A package connecting R and Azure DevOps

Description

This package takes a look at the Azure DevOps API calls and wraps them around in easy to use R functions. This includes looking at projects, repositories, work items, and eventually sections such as builds and releases.

Details

For more information about Azure DevOps APIs, take a look at https://docs.microsoft.com/en-us/rest/api/vsts

Projects

This looks at the projects available in a visual studio instance. This lets you change between any project that you might have access to.

Repositories

This looks primarily at the Git repositories available, and whether you want to create a new repository or delete an existing one.

Work Items

This will track any existing work item for a project, and also the ability to create a new work item for a project. Useful if working within a development team and automate inclusion of creating bugs upon creating any certain R error.

Releases

This will look at the releases available for a project, both the definitions and the actual releases. There is the ability to deploy the created releases to a new environment.

Custom

For any non-predefined API service available in the package, it is always possible to run the vsts_run_command which will use any enabled Azure DevOps API call.