danmetzler / psjira

PowerShell module to interact with Atlassian JIRA

PSJira

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

---

Documentation on ReadTheDocs

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

---

Project update: December 2016

Life is crazy - especially around the holidays - but I'm hard at work on a pretty significant code and documentation overhaul for version 2.0. I'm not able to commit to a timeline for this - depending on how much needs to get done and how much time I have, it could be very soon, or it could still be a couple months out. PSJira is a passion of mine, but (unfortunately) I've got other responsibilities that often take priority.

Please keep the feedback coming in the Issues page - I'm looking over that very closely - but please don't be offended if I'm not able to get back to you in a timely fashion. The community support and feedback I've received for this module is amazing, and I enjoy working with you all!

---

Requirements

This module has a hard dependency on PowerShell 3.0. I have no plans to release a version compatible with PowerShell 2, as I rely heavily 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 PSJira

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 PSJira folder to your $PSModulePath (normally, this is at C:\Users<username>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 PSJira is on the ReadTheDocs page.

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

Contributing

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

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

Contact

Feel free to comment on this project here on GitHub using the issues or discussion pages. You can also check out my blog or catch me on the PowerShell subreddit.

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