Turn your audience into a business. Publishing, memberships, subscriptions and newsletters.
Go to file
Simon Backx 6b3a657f88
Renamed newsletter_id and email_recipient_filter options (#14798)
refs https://github.com/TryGhost/Team/issues/1596

- Renamed `newsletter_id` to `newsletter` option, the `newsletter` option expects a slug instead of an id
- Renamed `email_recipient_filter` to `email_segment` option
- Default `email_segment` to `all`. Ignored if no newsletter is set
- `email_segment` is ignored if no newsletter is set
- When reverting a post to a draft, both `newsletter` and `email_segment` are reset to their default values (null, all)
- Removed legacy mapping from old email_recipient_filter values 'paid' and 'free' (already a migration in place)
- Dropped legacy throwing errors when email_recipient_filter is paid or free in transformEmailRecipientFilter
- Reorganized transformEmailRecipientFilter parameters for the now required newsletter parameter
- Fixed an issue where the newsletter filter wasn't working because it wasn't in permittedoptions
- Fixed an issue where you could send to an archived newsletter
- Added an extra protection when scheduling to an active, and later archiving the newsletter
- Dropped support for `send_email_when_published` in API
- When importing posts we currently don't have a system in place to set the newsletter_id to map the `send_email_when_published` behaviour. Since this was already the case, I won't include a fix in this PR.
- Stripped `email_recipient_filter`/`email_segment` from Content API (https://ghost.slack.com/archives/C02G9E68C/p1652363211841359?thread_ts=1650623650.233229&cid=C02G9E68C)
- Updated `admin-api-schema` to 3.2.0, which includes the new email_segment property
- Contains a temporary fix for https://github.com/TryGhost/Team/issues/1626, where the `.related('newsletter').fetch` call fails when the newsletter relation is already loaded, because of the overridden `formatOnWrite` method.

Since the `email_recipient_filter` is no longer used without a newsletter, the `none` value is no longer used. A migration transforms all those values to `all`. This should be safe, because we only send an email now when newsletter_id is not null (scheduled posts should already have a newsletter_id, even if at the time of scheduling they didn't add the newsletter_id option, because at that time, we defaulted to the default newsletter).

Admin changes to make this work: https://github.com/TryGhost/Admin/pull/2380
2022-05-16 10:18:04 +02:00
.github Fixed migrations running in CI tests 2022-05-09 11:49:53 +01:00
content 🎨 Updated Casper to v4.7.4 2022-04-08 16:00:32 +01:00
core Renamed newsletter_id and email_recipient_filter options (#14798) 2022-05-16 10:18:04 +02:00
test Renamed newsletter_id and email_recipient_filter options (#14798) 2022-05-16 10:18:04 +02:00
.c8rc.json 🔥 Removed versioned APIs 2022-04-28 15:37:09 +01:00
.editorconfig Removed Makefile settings from .editorconfig 2019-07-31 17:21:16 +08:00
.eslintignore Added new card src files to eslint ignore 2021-11-04 11:58:36 +00:00
.eslintrc.js Updated eslint ecma version to 2020 2022-05-10 20:20:02 +01:00
.gitattributes Enforced unix line endings (#9871) 2018-10-23 10:59:09 +02:00
.gitignore Added minified ghost.min.css to gitignore 2022-03-22 10:44:39 +00:00
.gitmodules Updated Ghost-Admin submodule url 2021-01-13 09:38:00 +00:00
.npmignore Fixed env specific default configuration files missing from build 2022-03-28 13:35:54 +01:00
config.development.json Fixed indentation in config.development.json 2020-05-04 16:41:02 +02:00
ghost.js Finalised new boot process 2021-02-19 13:15:12 +00:00
Gruntfile.js replaced deprecated String.prototype.substr() (#14367) 2022-04-28 11:49:12 +01:00
index.js Added new, simpler, linear boot process 2021-02-08 11:56:44 +00:00
jsconfig.json Enabled jsdoc in tests + fixed issue in e2e framework 2022-02-11 12:48:02 +00:00
LICENSE 2022 2022-01-05 12:41:30 +00:00
loggingrc.js Simplified the config logic in loggingrc (#13751) 2021-11-16 15:00:11 +00:00
MigratorConfig.js Replaced ghost-version.js with @tryghost/version 2021-06-16 13:16:15 +01:00
package.json Removed need for redundant "strip" attribute in schemas 2022-05-16 15:44:25 +08:00
PRIVACY.md Added UNPKG cdn to Privacy.md (#12964) 2021-10-21 10:24:28 +01:00
README.md Updated README.md 2022-03-11 14:43:57 +00:00
renovate.json 🐛 Fixed intermittent failures with embedding 2021-11-25 11:45:56 +01:00
SECURITY.md Updated ghost.org links 2021-01-19 13:28:36 +13:00
urls.json Booting instance with persisted urls 2021-11-13 01:01:28 +13:00
yarn.lock Removed need for redundant "strip" attribute in schemas 2022-05-16 15:44:25 +08:00

 

Ghost Ghost

 

Ghost.orgForumDocsContributingTwitter

Downloads Latest release Build status Contributors

Love open source? We're hiring Node.js engineers to work on Ghost full-time.

 

Fiercely independent, professional publishing. Ghost is the most popular open source, headless Node.js CMS which already works with all the tools you know and love.  

Ghost(Pro) Ghost(Pro)

The easiest way to get a production instance deployed is with our official Ghost(Pro) managed service. It takes about 2 minutes to launch a new site with worldwide CDN, backups, security and maintenance all done for you.

For most people this ends up being the best value option cause of how much time it saves — and 100% of revenue goes to the Ghost Foundation; funding the maintenance and further development of the project itself. So youll be supporting open source software and getting a great service!

If you prefer to run on your own infrastructure, we also offer official 1-off installs and managed support and maintenance plans via Ghost(Valet) - which can save a substantial amount of developer time and resources.

 

Quickstart install

If you want to run your own instance of Ghost, in most cases the best way is to use our CLI tool

npm install ghost-cli -g

 

Then, if installing locally add the local flag to get up and running in under a minute - Local install docs

ghost install local

 

or on a server run the full install, including automatic SSL setup using LetsEncrypt - Production install docs

ghost install

 

Check out our official documentation for more information about our recommended hosting stack & properly upgrading Ghost, plus everything you need to develop your own Ghost themes or work with our API.

Contributors & advanced developers

For anyone wishing to contribute to Ghost or to hack/customize core files we recommend following our full development setup guides: Contributor guideDeveloper setupAdmin Client dev guide

 

Ghost sponsors

We'd like to extend big thanks to our sponsors and partners who make Ghost possible. If you're interested in sponsoring Ghost and supporting the project, please check out our profile on GitHub sponsors ❤️

DigitalOceanFastly

 

Getting help

You can find answers to a huge variety of questions, along with a large community of helpful developers over on the Ghost forum - replies are generally very quick. Ghost(Pro) customers also have access to 24/7 email support.

To stay up to date with all the latest news and product updates, make sure you subscribe to our blog — or you can always follow us on Twitter, if you prefer your updates bite-sized and facetious. 🎷🐢

 

Copyright & license

Copyright (c) 2013-2022 Ghost Foundation - Released under the MIT license. Ghost and the Ghost Logo are trademarks of Ghost Foundation Ltd. Please see our trademark policy for info on acceptable usage.