README.md

Cake.Jira

Cake addin for integration with Jira Issue Tracker

Using it

In order to use the add-in just reference it as you would any other cake add-in:

#addin nuget:?package=Cake.Jira

After that you can use the aliases available.

Currently the add-in supports:

• One alias for creating a version on Jira.

Usage:

Task("Create-Jira-Version")
  .Does(async () => {
    await CreateOrUpdateJiraVersion(
      new CreateOrUpdateJiraVersionSettings
      {
        Host = "https://your.jira.host.com",
        User = "JustAUser",
        Password = "SuperSecurePassword",
        Project = "ProjectKey",
        Description = "Something something bla bla bla lorem freaking ipsum",
        VersionName = "1.0.0",
        ReleaseDate = DateTime.Now
      }
    );
  });

• One alias for moving all issues from one version to another:

Usage:

Task("Migrate-Issues-To-Version")
  .Does(async () => {
    await MigrateIssuesVersion(new MigrateIssuesVersionSettings{
      Host = "https://your.jira.host.com",
      User = "JustAUser",
      Password = "SuperSecurePassword",
      Project = "ProjectKey",
      FromVersion = "AnOldVersion",
      ToVersion = "ABrandNewVersion",
    });
  });

• One alias for creating a new jira issue:

The properties Host, Project and Summary are required.

Usage:

Task("Create-Jira-Issue")
  .Does(async () => {
    var labels = new List<string>();
    labels.Add("Label A");
    labels.Add("Label B");

    await CreateJiraIssue(new CreateIssueSettings{
      Host = "https://your.jira.host.com",
      User = "JustAUser",
      Password = "SuperSecurePassword",
      Project = "ProjectKey",
      Summary = "Summary",
      Reporter = "Reporter",
      Description = "Description",
      Environment = "Environment",
      Assignee = "Assignee",
      Priority = 1,
      Type = 1,
      Labels = labels,
      DueDate = new DateTime(2018, 12, 24)
    });
  });

Contributing

This repo follows the Fork and Pull Request standard. You should follow those guidelines in order to contribute.