robertklohr / powershellforlockpath

PowerShell Module for Using the Lockpath API

PowerShellForLockpath

Table of Contents

• PowerShellForLockpath
  • Table of Contents
  • Overview
  • Current API Support
  • Installation
  • Configuration
  • Usage
  • Logging
  • Developing and Contributing
  • Creating a Release
  • Versioning
  • Code of Conduct
  • Maintainers
  • Legal and Licensing
  • Acknowledgements

---

Overview

This is a PowerShell module that provides command-line interaction and automation for the Lockpath API.

---

Current API Support

At present this module supports all API methods except IssueAssessments.

Development is ongoing, with the goal to add broad support for the entire API set.

For a comprehensive look at what work is remaining to be API Complete, refer to Change Log.

Review examples to see how the module can be used to accomplish some of these tasks.

---

API Documentation

There is an Insomnia v4 collection configuration file in docs/api/insomnia.

There is also an set of HTML files that provides an interactive version of the Insomnia collection that requires a web server to view in docs/api/wwww.

---

Installation

You can get latest release of the PowerShellForLockpath on the PowerShell Gallery

Install-Module -Name PowerShellForLockpath

---

Configuration

A number of configuration options exist with this module and they can be configured with Set-LockpathConfiguration. For a full explanation of all possible configurations, run the following:

Get-Help Set-LockpathConfiguration -ShowWindow

For example you can save yourself a lot of typing by configuring the default PageIndex and/or PageSize that you work with. You can always override these values by explicitly providing a value for the parameter in an individual command, but for the common scenario, you'd have less typing to do.

Set-LockpathConfiguration -PageIndex 0
Set-LockpathConfiguration -PageSize 500

There are more great configuration options available. Just review the help for that command for the most up-to-date list!

---

Usage

Example command:

$issues = Get-LockpathUser -id 6

For more example commands, please refer to USAGE.

---

Logging

All commands and errors will log to the console, as well as to a log file.

For more example commands, please refer to USAGE.

---

Developing and Contributing

Please see the Contribution Guide for information on how to develop and contribute.

If you have any problems, please consult GitHub Issues to see if has already been discussed.

If you do not see your problem captured, please file feedback.

---

Creating a Release

================

• Update changelog (changelog.md) with the new version number based on Semantic Versioning (SemVer) version 2.0.0 https://semver.org/spec/v2.0.0.html.

• Sign the binaries and PowerShell files in the release build and publish the module to PowerShell Gallery.
• Draft a new release on github and tag master with the new version number.

Versioning

This module uses Semantic Versioning (SemVer) version 2.0.0 https://semver.org/spec/v2.0.0.html.

---

Code of Conduct

For more info, see Code of Conduct

---

Maintainers

• Robert Klohr

---

Legal and Licensing

PowerShellForLockpath is licensed under the MIT license.

Acknowledgements

Gregory Schier - For creating the Insomnia Open Source API Client.
Oliver Lachlan - For creating the Keep a Changelog format.
Tom Preston-Werner - For authoring the Semantic Versioning Specification.