loungebuddy-set-to-fixed v1.0.2
setToFixed
NPM module for the setToFixed script used on services repos to remove the RELEASED label from issues and to add the FIXED label (Github API Reference: https://developer.github.com/v3/issues/)
Installation & Use
npm install loungebuddy-set-to-fixed
var setToFixed = require('loungebuddy-set-to-fixed).run()
var labelScript = require('loungebuddy-set-to-fixed').run({
accessToken: "",
username: "",
repo: "",
owner: "",
targetLabels: ["TEST_RELEASE"],
resultLabels: ["TEST_FIXED"]
});
Parameters
Parameters can be passed via either ENV variables (in the process env or a .env file) OR via a dictionary argument to run
, except for label params which should be passed as options to run
if a non-default arg is desired
Required Parameters:
- Github Access Token: passed either in run options with the
accessToken
property or in ENV asGITHUB_ACCESS_TOKEN
. - Github Username: passed either in run options with
username
property or in ENV asGITHUB_USERNAME
. - Github Repository Name: passed either in run options with
repo
property or in ENV asGITHUB_REPO
. Github Reposityory Owner: passed either in run options with
owner
property or in ENV asGITHUB_OWNER
.
Optional Parameters:
- Labels To Remove: passed either in run options with the
targetLabels
property. Defaults to 'RELEASE' Labels to Add: passed either in run options with the
resultLabels
property. Defaults to 'FIXED', 'Aha!:Ready To Ship'