Skip to content

Latest commit

 

History

History
55 lines (30 loc) · 2.97 KB

README.md

File metadata and controls

55 lines (30 loc) · 2.97 KB

Build status Documentation Status

JiraPS is a Windows PowerShell module to interact with Atlassian JIRA via a REST API, while maintaining a consistent PowerShell look and feel.

Join the conversation on SlackLogo AtlassianPS.Slack.com


Documentation on ReadTheDocs

Documentation for JiraPS has moved to ReadTheDocs.io. Check it out, and feel free to submit issues or PRs against the documentation as well!


Requirements

This module has a hard dependency on PowerShell 3.0. There are no plans to release a version compatible with PowerShell 2, as the module relies on several cmdlets and features added in version 3.0.

Downloading

Due to the magic of continuous integration, the latest passing build of this project will always be on the PowerShell Gallery. If you have the Package Management module for PowerShell (which comes with PowerShell 5.0), you can install the latest build easily:

Install-Module JiraPS

If you're using PowerShell 3 or 4, consider updating! If that's not an option, consider installing PackageManagement on PowerShell 3 or 4 (you can do so from the PowerShell gallery using the MSI installer link).

You can also download this module from the Download Zip button on this page. You'll need to extract the JiraPS folder to your $PSModulePath (normally, this is at C:\Users\\Documents\WindowsPowerShell\Modules).

Finally, you can check the releases page here on GitHub for "stable" versions, but again, PSGallery will always have the latest (tested) version of the module.

Usage

All the documentation for JiraPS is on the ReadTheDocs page.

For basic instructions to get up and running, check out the Getting Started page.

Contributing

Want to contribute to JiraPS? Great! Start with the Contributing page on the project documentation - it will explain how to work with JiraPS's test and CI systems.

Pull requests for JiraPS are expected to pass all Pester tests before being merged. More details can be found on the project documentation site.

Contact

Join the conversation on SlackLogo AtlassianPS.Slack.com
Or write an email to contact@atlassianps.org

Note: As with all community PowerShell modules and code, you use JiraPS at your own risk. I am not responsible if your JIRA instance causes a fire in your datacenter (literal or otherwise).