History

Naz 014fafbafb Published new versions - @tryghost/adapter-manager@0.2.29 - @tryghost/api-version-compatibility-service@0.1.0 - @tryghost/bootstrap-socket@0.2.18 - @tryghost/config-url-helpers@0.1.6 - @tryghost/constants@1.0.3 - @tryghost/database-info@0.3.2 - @tryghost/image-transform@1.0.30 - @tryghost/job-manager@0.8.22 - @tryghost/limit-service@1.0.11 - @tryghost/minifier@0.1.13 - @tryghost/moleculer-service-from-class@0.2.24 - @tryghost/mw-api-version-mismatch@0.1.0 - @tryghost/mw-error-handler@0.2.1 - @tryghost/mw-session-from-token@0.1.29 - @tryghost/mw-update-user-last-seen@0.1.4 - @tryghost/package-json@1.0.19 - @tryghost/pretty-cli@1.2.25 - @tryghost/promise@0.1.16 - @tryghost/release-utils@0.7.13 - @tryghost/security@0.2.16 - @tryghost/session-service@0.1.39 - @tryghost/settings-path-manager@0.1.5 - @tryghost/vhost-middleware@1.0.23 - @tryghost/zip@1.1.23		2022-04-21 20:58:17 +08:00
..
lib	Updated default changelog content if no emojis exist	2022-02-04 14:25:44 +01:00
test	Renamed `TryGhost/Ghost-Utils` links to `TryGhost/Utils`	2021-01-12 16:40:16 +00:00
.eslintrc.js
LICENSE	2022	2022-01-06 09:52:35 +00:00
package.json	Published new versions	2022-04-21 20:58:17 +08:00
README.md	2022	2022-01-06 09:52:35 +00:00

README.md

Release Utils

Install

npm install @tryghost/release-utils --save

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 eslint
yarn test run lint and tests