Giter Club home page Giter Club logo

create-workitem-azdo-tfs's Introduction

Create Azure Devops\TFS WorkItem

Build and Test

This GitHub Action automates the process of creating work items in Azure DevOps or TFS.
It allows for the creation of work items of various types and provides the option to attach files to them.

Usage

See action.yml

- uses: develeap/Create-WorkItem-AzDO-TFS@v1
  with:
    # Azure Devops/tfs personal access token
    # [More about how to create a personal access token](https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate)
    # required: true
    token: ''

    # Azure Devops/tfs organization url.
    # For Azure devops: https://dev.azure.com/{organization}
    # For tfs: https://{server:port}/tfs/{collection}
    # [More about organization url](https://learn.microsoft.com/en-us/rest/api/azure/devops)
    # required: true
    organization_url: ''

    # The team project in which to create the new work item.
    # For example: myProject
    # [More about team projects](https://learn.microsoft.com/en-us/azure/devops/organizations/projects/about-projects?view-projects-in-your-organization)
    # required: true
    project: ''

    # Specify the work item type you want to create
    # Example: 'Bug' or 'Task' or 'User Story' or 'Feature' or 'Epic'
    # You can get the project work item types with REST API.
    # [More about work item type](https://learn.microsoft.com/en-us/rest/api/azure/devops/wit/work-item-types/list)
    # required: true
    workitem_type: ''

    # Work item fields mappings to be added to the defect in TFS.
    # Field consists of referenceName and value.
    # Example: 'Title = Title of the defect'
    # [More about work item type fields](https://learn.microsoft.com/en-us/azure/devops/boards/work-items/guidance/work-item-field?view=azure-devops)
    # You can get list of your project fields with REST API.
    # [More about fields REST API](https://learn.microsoft.com/en-us/rest/api/azure/devops/wit/fields/list)
    # required: true
    field_Mappings: ''

    # Files to attach to the work item.
    # Can be file name in the current directory, absolute path to file or path with wildcard.
    # Example: 'file.txt' or 'C:\file.txt' or 'C:\*.txt'
    # required: false
    attach_files: ''

Basic

- uses: develeap/Create-WorkItem-AzDO-TFS@v1
  with:
    token: '${{ secrets.azure_devops_token }}'
    organization_url: 'https://dev.azure.com/yourOrgName'
    project: 'yourProjectName'
    workitem_type: 'Task'
    field_mappings: |
      'Title = Test'
      'Tags = Auto Create Task'
      'Assigned To = someone'
      'AreaPath = test'

The field_mappings input need to contain a valid workitem field, either a default fields or custom field.

Attach Files

Files can be attached to the work item to provide additional context or documentation.
You can specify file paths as absolute or relative to the current directory, and wildcard characters are supported.
Example:

Linux \ Macos
- uses: develeap/Create-WorkItem-AzDO-TFS@v1
  with:
    token: '${{ secrets.azure_devops_token }}'
    organization_url: 'https://dev.azure.com/yourOrgName'
    project: 'yourProjectName'
    workitem_type: 'Task'
    field_mappings: |
      'Title = Test'
      'Tags = Auto Create Task'
      'Assigned To = someone'
      'AreaPath = test'
    attach_files: |
      '*.txt'
      'File-1.txt'
      '${{ github.workspace }}/File-2.txt'
Windows
- uses: develeap/Create-WorkItem-AzDO-TFS@v1
  with:
    token: '${{ secrets.azure_devops_token }}'
    organization_url: 'https://dev.azure.com/yourOrgName'
    project: 'yourProjectName'
    workitem_type: 'Task'
    field_mappings: |
      'Title = Test'
      'Tags = Auto Create Task'
      'Assigned To = someone'
      'AreaPath = test'
    attach_files: |
      '*.txt'
      'File-1.txt'
      '${{ github.workspace }}\File-2.txt'

create-workitem-azdo-tfs's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.