ab5ced6bdd
- @tryghost/adapter-manager@0.1.10 - @tryghost/bootstrap-socket@0.2.1 - @tryghost/constants@0.1.0 - @tryghost/errors@0.2.3 - @tryghost/image-transform@1.0.3 - @tryghost/moleculer-service-from-class@0.2.5 - @tryghost/mw-session-from-token@0.1.7 - @tryghost/pretty-cli@1.2.9 - @tryghost/release-utils@0.6.5 - @tryghost/session-service@0.1.8 - @tryghost/vhost-middleware@1.0.8 - @tryghost/zip@1.1.3 |
||
---|---|---|
.. | ||
lib | ||
test | ||
.eslintrc.js | ||
LICENSE | ||
package.json | ||
README.md |
Release Utils
Install
npm install @tryghost/release-utils --save
or
yarn add @tryghost/release-utils
Usage
Create Gist:
const releaseUtils = require('@tryghost/release-utils');
releaseUtils
.gist
.create({
userAgent: String,
gistName: String,
gistDescription: String,
changelogPath: String [Path on Disk]
github: {
username: String
token: String
},
isPublic: Boolean [optional, Default: true]
})
Create Changelog:
const releaseUtils = require('@tryghost/release-utils');
const changelog = new releaseUtils.Changelog({
changelogPath: String [Path on Disk],
folder: String [Path on Disk]
});
changelog
.write({
githubRepoPath: String,
lastVersion: String
})
.write({
githubRepoPath: String
lastVersion: String
append: Boolean [optional, Default: false],
folder: String [optional, Path on Disk]
})
.sort()
.clean()
Create & Upload Release:
const releaseUtils = require('@tryghost/release-utils');
releaseUtils
.releases
.create({
tagName: String,
releaseName: String,
userAgent: String,
uri: String,
github: {
username: String,
token: String,
},
changelogPath: String [Path on Disk] OR Array[{
changelogPath: String [Path on Disk],
content: Array [optional]
}],
gistUrl: String [optional],
preRelease: Boolean [optional, Default: false],
draft: Boolean [optional, Default: true],
filterEmojiCommits: Boolean [optional, Default: true],
content: Array [optional]
});
releaseUtils
.releases
.uploadZip({
github: {
username: String,
token: String
},
zipPath: String [Path on Disk],
uri: String,
userAgent: String
})
Develop
This is a mono repository, managed with lerna.
Follow the instructions for the top-level repo.
git clone
this repo &cd
into it as usual- Run
yarn
to install top-level dependencies.
Run
yarn dev
Test
yarn lint
run just eslintyarn test
run lint and tests
Copyright & License
Copyright (c) 2013-2020 Ghost Foundation - Released under the MIT license.