Skip to content

cake-contrib/Cake.Board

Repository files navigation

Cake.Board

Cake Addin for work with work items boards.

Gitter codecov

Build status

OS Build & Test
Windows x64 Build Status
Linux x64 Build Status

Publish packages status

Package NuGet NuGet Pre-Release
Cake.Board.Abstractions Nuget Nuget (with prereleases)
Cake.Board Nuget Nuget (with prereleases)
Cake.Board.AzureBoards Nuget Nuget (with prereleases)
Cake.Board.Asana Nuget Nuget (with prereleases)

Usage

Azure Boards

In order to usage this addin, add to your Cake script.

#addin "nuget:?package=Cake.Board.AzureBoards&loaddependencies=true"
#addin "nuget:?package=Polly"
Task("GetWorkItemById")
  .Does(async () => 
  {
    IWorkItem workItem = await GetWorkItemByIdAsync(
      new AzureBoards(
        EnvironmentVariable("PERSONAL_ACCESS_TOKEN"),
        EnvironmentVariable("AZURE_DEVOPS_ORGANIZATION")),
      id);
  });

or

Task("GetWorkItemsByQueryIdAsync")
  .Does(async () => 
  {
    var board = new AzureBoards(
      EnvironmentVariable("PERSONAL_ACCESS_TOKEN"),
      EnvironmentVariable("AZURE_DEVOPS_ORGANIZATION"))
      {
        Project = EnvironmentVariable("AZURE_DEVOPS_PROJECT"),
        Team = EnvironmentVariable("AZURE_DEVOPS_TEAM")
      };

    IEnumerable<IWorkItem> workItems = await GetWorkItemsByQueryIdAsync(
      board,
      queryId);
  });

Contributing

You’re thinking about contributing to Cake.Board? Great! It’s really appreciated. Please make small changes focused on the purpose of the branch in order to make the changes easily integrable.

For major changes, please open an issue first to discuss what you would like to change.

How to

All you have to do to get started is this!

  1. git clone https://github.com/cake-contrib/Cake.Board.git
  2. git checkout -b <YOUR_BRANCH_NAME>
  3. Don't forget the unit tests.
  4. Please make sure to update tests as appropriate.
  5. Send a pull request.

License

MIT license