Scheduled Publishing and Unpublishing plugin for Sanity.io

This is forked from @sanity/scheduled-publishing and adds unpublishing

> This is a Sanity Studio v3 plugin.
> For the v2 version, please refer to the v2-branch.

What is it?

Schedule your content for future publication and organise upcoming releases – no custom tasks or serverless functions required!

> This plugin uses Sanity's [Scheduling API][scheduling-api] which is available to customers on [Growth or higher plans][pricing].

!Scheduled Publishing tool view

!Scheduled Publishing document view

Table of contents

- Features
- Getting started
- Install
- Usage
- Manually configuring the Schedule document action
- Manually configuring the Schedule document badge
- FAQ
- Changes from Sanity Studio v2 version

Features

$3

- Create and edit schedules for the document you're working on
- See current schedule status and potential validation issues

$3

- Filter all schedules by status or use the calendar to browse by date
- Edit, delete, and immediately publish schedules
- Automatically validate upcoming schedules, and identify issues before they're published
- Easily identify who created a schedule

$3

- Change the time zone you want to preview schedules in by clicking the 🌎 Time Zone button when visible. Great when you need to co-ordinate with a global team or want to time publication to specific regions.
- Easily select time zones by city, time zone abbreviation or name search.
- Selected time zones are automatically stored in your local storage for future use.

Getting started

Installation

``
npm install --save @burgersonbrioche/sanity-scheduled-publishing
`

or

`
yarn add @burgersonbrioche/sanity-scheduled-publishing
`

Usage

Add it as a plugin in sanity.config.ts (or .js):

`js
import {scheduledPublishing} from '@burgersonbrioche/sanity-scheduled-publishing'

export default defineConfig({
// ...
plugins: [scheduledPublishing()],
})
`

This will automatically:

1. Add a Schedule [document action][document-actions] to all document schema types
2. Display a Scheduled [document badge][document-badges] to all document schema types
3. Add the dedicated Schedules tool in your navigation bar

$3

To change the date formatting used when creating and editing schedules, pass a valid date-fns formatted token as an option.

`js
plugins: [
// Make sure to specify a time component if you're specifying a custom format!
scheduledPublishing({
// E.g. 12/25/2000 6:30 AM
inputDateTimeFormat: 'MM/dd/yyyy h:mm a',
})
],
`

If left unspecified, this plugin will default to dd/MM/yyyy HH:mm.

$3

This example assumes [you've customized your document actions][document-actions] and would like to only show the Schedule button on movie documents only.

The Schedule document action allows users to both create and edit existing schedules directly from the form editor. It is added to all document types by the plugin,
so you should remove it from types that should NOT have it.

`js
import {scheduledPublishing, ScheduleAction} from '@burgersonbrioche/sanity-scheduled-publishing'

export default defineConfig({
// ...
plugins: [scheduledPublishing()],
document: {
actions: (previousActions, {schemaType}) => {
/*
* Please note that this will only alter the visibility of the button in the studio.
* Users with document publish permissions will be able to create schedules directly
* via the Scheduled Publishing API.
*/
if (schemaType.name !== 'movie') {
// Remove the schedule action from any documents that is not 'movie'.
return previousActions.filter((action) => action !== ScheduleAction)
}
return previousActions
},
},
})
`

$3

This example assumes [you've customised your own document badges][document-badges] and would like to only show the Scheduled badge on movie documents only.

The Scheduled document badge displays whether the current document is scheduled and when it will be published if so. It is added to all document types by the plugin,
so you should remove it from types that should NOT have it.

`js
import {scheduledPublishing, ScheduledBadge} from '@burgersonbrioche/sanity-scheduled-publishing'

export default defineConfig({
// ...
plugins: [scheduledPublishing()],
document: {
actions: (previousBadges, {schemaType}) => {
if (schemaType.name !== 'movie') {
// Remove the schedule badge from any documents that is not 'movie'.
return previousBadges.filter((badge) => badge !== ScheduledBadge)
}
return previousBadges
},
},
})
`

FAQ

$3

The Studio V3 version differs from the v2 versions in a few ways:

- Actions and badges now auto-compose with other document actions by default. This is the _opposite_ of how the v2 version behaves:
It is no longer necessary to compose actions and badges manually when there are other plugins that add those to studio.
- This means that you now have to _remove_ the Schedule Action from types that _should not_ have it, as opposed to _add_ it for those that should like in v2.

Develop & test

This plugin uses @sanity/plugin-kit
with default configuration for build & watch scripts.

See Testing a plugin in Sanity Studio
on how to run this plugin with hot-reload in the studio.

$3

Run the CI & Release workflow.
Make sure to select the main branch and check "Release new version".

Semantic release will only release on configured branches, so it is safe to run release on any branch.

[document-actions]: https://www.sanity.io/docs/document-actions
[document-badges]: https://www.sanity.io/docs/custom-document-badges
[scheduling-api]: https://www.sanity.io/docs/scheduling-api
[@vvo/dztb]: https://github.com/vvo/tzdb
[pricing]: https://www.sanity.io/pricing

License

This repository is published under the MIT license.