mirror of https://github.com/TryGhost/Ghost.git synced 2024-11-30 21:40:39 +03:00

History

Daniel Lockyer 713cbd3cc4 Unpinned all dependencies no issue - this Utils repo contains libraries, whose dependencies should not be pinned in order to reduce multiple versions of the same package appearing for consumers		2021-04-16 13:06:54 +01:00
..
lib	Updated release to optionally take a targetRef	2021-02-09 11:51:33 +00:00
test	Renamed `TryGhost/Ghost-Utils` links to `TryGhost/Utils`	2021-01-12 16:40:16 +00:00
.eslintrc.js	Remove trailing commas from .eslintrc.js files	2020-08-04 14:48:07 +01:00
LICENSE	2021	2021-01-25 16:20:43 +00:00
package.json	Unpinned all dependencies	2021-04-16 13:06:54 +01:00
README.md	2021	2021-01-25 16:20:43 +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