History

Naz c5b8d073d7 Published new versions - @tryghost/adapter-manager@0.2.31 - @tryghost/api-version-compatibility-service@0.3.0 - @tryghost/bootstrap-socket@0.2.20 - @tryghost/config-url-helpers@0.1.8 - @tryghost/constants@1.0.5 - @tryghost/database-info@0.3.5 - @tryghost/email-content-generator@0.1.2 - @tryghost/image-transform@1.0.32 - @tryghost/job-manager@0.8.24 - @tryghost/limit-service@1.1.3 - @tryghost/minifier@0.1.15 - @tryghost/moleculer-service-from-class@0.2.26 - @tryghost/mw-api-version-mismatch@0.1.4 - @tryghost/mw-error-handler@1.0.1 - @tryghost/mw-session-from-token@0.1.32 - @tryghost/mw-update-user-last-seen@0.1.6 - @tryghost/package-json@1.0.21 - @tryghost/pretty-cli@1.2.27 - @tryghost/promise@0.1.18 - @tryghost/release-utils@0.7.15 - @tryghost/security@0.3.1 - @tryghost/session-service@0.1.42 - @tryghost/settings-path-manager@0.1.7 - @tryghost/update-check-service@0.3.4 - @tryghost/version-notifications-data-service@0.1.2 - @tryghost/zip@1.1.25		2022-05-09 18:25:48 +08:00
..
lib
test
.eslintrc.js
LICENSE	2022	2022-01-06 10:17:41 +00:00
package.json	Published new versions	2022-05-09 18:25:48 +08:00
README.md	2022	2022-01-06 10:17:41 +00:00

README.md

Update Check Service

Makes a request to updates.ghost.org to check for release & custom notifications. The service is provided in return for users opting in to anonymous usage data collection.

Install

npm install @tryghost/update-check-service --save

yarn add @tryghost/update-check-service

Usage

Check the UpdateCheckService's constructor JSDoc for the list of available parameters. This is how the service is initialized in Ghost:

const api = require('./api').v2;
const GhostMailer = require('./services/mail').GhostMailer;
const config = require('../shared/config');
const urlUtils = require('./../shared/url-utils');

const i18n = require('../shared/i18n');
const logging = require('../shared/logging');
const request = require('./lib/request');
const ghostVersion = require('./lib/ghost-version');
const UpdateCheckService = require('@tryghost/update-check-service');

const updateChecker = new UpdateCheckService({
    api: {
        settings: {
            read: api.settings.read,
            edit: api.settings.edit
        },
        posts: {
            browse: api.posts.browse
        },
        users: {
            browse: api.users.browse
        },
        notifications: {
            add: api.notifications.add
        }
    },
    config: {
        mail: config.get('mail'),
        env: config.get('env'),
        databaseType: config.get('database').client,
        checkEndpoint: config.get('updateCheck:url'),
        isPrivacyDisabled: config.isPrivacyDisabled('useUpdateCheck'),
        notificationGroups: config.get('notificationGroups'),
        siteUrl: urlUtils.urlFor('home', true),
        forceUpdate: config.get('updateCheck:forceUpdate'),
        ghostVersion: ghostVersion.original
    },
    i18n,
    logging,
    request,
    sendEmail: ghostMailer.send
});

// run the update check with 

updateChecker.check();

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