Patience and the right tools II – ways to handle  content model changes

Slide 1

Slide 1 text

Patience and the right tools @stefanjudis Ways to handle  content model changes

Slide 2

Slide 2 text

Stefan Judis Frontend Developer, Occasional Teacher, Meetup Organizer ❤ Open Source, Performance and Accessibility ❤ @stefanjudis

Slide 3

Slide 3 text

NOBODY(!) GETS IT RIGHT THE FIRST TIME...

Slide 4

Slide 4 text

4 WAYS TO SURVIVE SHARE & REUSE ANALYSE EVOLVE

Slide 5

Slide 5 text

5 WAYS TO SURVIVE SHARE & REUSE ANALYSE EVOLVE

Slide 6

Slide 6 text

github.com/contentful/contentful-migration

Slide 7

Slide 7 text

github.com/contentful/contentful-migration PROGRAMMATIC CONTENT MODEL CHANGES

Slide 8

Slide 8 text

MIGRATION CLI CONTENT TYPE OPERATIONS Create a content type 01 02 03 04 05 Delete a content type Edit a content type Create/edit/delete ﬁelds Change a ﬁeld ID

Slide 9

Slide 9 text

Transform an entry in place 01 02 Derive an entry from another MIGRATION CLI CONTENT TRANSFORMATIONS

Slide 10

Slide 10 text

MIGRATION CLI ADVANTAGES Repeatable 01 02 03 04 Can be kept in VC Includes sanity checks Perfect for CI

Slide 11

Slide 11 text

No content

Slide 12

Slide 12 text

speakerdeck.com/stefanjudis/patience-and-the-right-tools-ways-to-approach-content-modelling youtu.be/eX2FzlA-QnQ

Slide 13

Slide 13 text

13 How to DISCARD TEST PREVIEW a migration?

Slide 14

Slide 14 text

Sandbox Environments

Slide 15

Slide 15 text

No content

Slide 16

Slide 16 text

CREATE MULTIPLE VERSIONS OF A SPACE CHANGE/TEST THEM IN ISOLATION

Slide 17

Slide 17 text

cdn.contentful.com/spaces/{space_id}/entries const contentful = require('contentful'); const client = contentful.createClient({ space: '', accessToken: '' }); client.getEntries();

Slide 18

Slide 18 text

cdn.contentful.com/spaces/{space_id}/environments/{environment_id}/entries const contentful = require('contentful'); const client = contentful.createClient({ space: '', environment: '', accessToken: '' }); client.getEntries();

Slide 19

Slide 19 text

COPIED Content types Entries Assets Locales UI-extensions Saved views SHARED Users & space memberships Roles & permissions API keys Web hooks

Slide 20

Slide 20 text

youtu.be/7DE6PQ3tPyI

Slide 21

Slide 21 text

21 Common use cases LOCAL DEVELOPMENT STAGING/QA CONTINUOUS INTEGRATION

Slide 22

Slide 22 text

22 Common use cases LOCAL DEVELOPMENT STAGING/QA CONTINUOUS INTEGRATION

Slide 23

Slide 23 text

No content

Slide 24

Slide 24 text

24 Common use cases LOCAL DEVELOPMENT STAGING/QA CONTINUOUS INTEGRATION

Slide 25

Slide 25 text

FEATURE SANDBOXES

Slide 26

Slide 26 text

FEATURE SANDBOXES ENVIRONMENT SANDBOXES

Slide 27

Slide 27 text

ENVIRONMENT SANDBOXES FEATURE SANDBOXES CI SANDBOXES

Slide 28

Slide 28 text

www.contentful.com/r/knowledgebase/cms-as-code/ www.contentful.com/developers/docs/concepts/multiple-environments/

Slide 29

Slide 29 text

www.contentful.com/r/knowledgebase/cms-as-code/ www.contentful.com/developers/docs/concepts/multiple-environments/ BUT HOW TO DO THIS?

Slide 30

Slide 30 text

No content

Slide 31

Slide 31 text

migrations 0_0_4.js 0_0_5.js 0_0_6.js 0_0_7.js 0_0_8.js

Slide 32

Slide 32 text

0_0_8.js module.exports = function runMigration(migration) { const post = migration.editContentType("post"); post .createField("rating") .name("Rating") .type("Number") .required(false); return; };

Slide 33

Slide 33 text

- run: name: Preparing environment for testing command: | . venv/bin/activate python scripts/migration_prep.py "CI_$CIRCLE_BRANCH" scripts/migrate.js $SPACE_ID "CI_$CIRCLE_BRANCH" $MANAGEMENT_API_KEY

Slide 34

Slide 34 text

- run: name: Preparing environment for testing command: | . venv/bin/activate python scripts/migration_prep.py "CI_$CIRCLE_BRANCH" scripts/migrate.js $SPACE_ID "CI_$CIRCLE_BRANCH" $MANAGEMENT_API_KEY client = contentful_management.Client(MANGEMENT_API_KEY) environment = client.environments(SPACE_ID).create(TESTING_ENV, {"name": TESTING_ENV})

Slide 35

Slide 35 text

- run: name: Preparing environment for testing command: | . venv/bin/activate python scripts/migration_prep.py "CI_$CIRCLE_BRANCH" scripts/migrate.js $SPACE_ID "CI_$CIRCLE_BRANCH" $MANAGEMENT_API_KEY const {default: runMigration} = require('contentful-migration/built/bin/cli'); await runMigration({ /* ... */ }); client = contentful_management.Client(MANGEMENT_API_KEY) environment = client.environments(SPACE_ID).create(TESTING_ENV, {"name": TESTING_ENV})

Slide 36

Slide 36 text

Keep code and content model in sync

Slide 37

Slide 37 text

Demo

Slide 38

Slide 38 text

Feedback? Ideas?

Slide 39

Slide 39 text

Integrate your content model into your delivery pipeline

Slide 40

Slide 40 text

Thanks. @stefanjudis Slides ctﬂ.io/ci-environments Example ctﬂ.io/ci-environments-example