contentful-export 8.4.0 → 8.5.0

package/README.md

@@ -186,7 +186,7 @@ Content Delivery API.
 
 #### `includeArchived` [boolean] [default: false]
 
-Include archived entries in the exported entries
+Include archived entries and assets in the exported data. This option does not include archived Releases.
 
 #### `skipContentModel` [boolean] [default: false]
 
@@ -212,6 +212,10 @@ Skip exporting tags
 
 Skip exporting webhooks
 
+#### `skipReleases` [boolean] [default: false]
+
+Skip exporting [Releases](https://www.contentful.com/help/releases/). See the "Releases" section below for what's exported when this is on.
+
 #### `stripTags` [boolean] [default: false]
 
 Untag assets and entries
@@ -339,6 +343,7 @@ This is an overview of the exported data:
   "webhooks": [],
   "roles": [],
   "editorInterfaces": [],
+  "releases": [],
   "designTokens": [],
   "components": [],
   "experienceTemplates": [],
@@ -365,6 +370,8 @@ _Note:_ Tags feature is not available for all users. If you do not have access t
 
 _Note:_ `designTokens`, `components`, `experienceTemplates`, `dataAssemblies`, `experienceFragments`, and `experiences` are Experience Orchestration (ExO) entities — present by default; absent only if you explicitly set `includeExperienceOrchestration: false` — see the "Experience Orchestration (ExO) entities" section below.
 
+_Note:_ `releases` is present by default; absent only if you explicitly set `skipReleases: true` — see the "Releases" section below. It's a separate, GA Contentful feature, not part of ExO.
+
 ## :test_tube: Experience Orchestration (ExO) entities
 
 Experience Orchestration (ExO) is Contentful's system for composing and rendering structured page experiences. It sits above the traditional entry/content-type layer and provides six dedicated entity types — Design Tokens, Components, Experience Templates, Data Assemblies, Experience Fragments, and Experiences — that together describe how content is fetched, assembled, and laid out.
@@ -410,6 +417,20 @@ Unlike the six entity types above, variants are **not** exported as a seventh to
 
 The ExO entities exported here are designed to be fed directly into [`contentful-import`](https://github.com/contentful/contentful-import), which preserves source IDs, applies dependency ordering (a topological sort for Components and Experience Fragments, since either can reference others of the same type), and upgrades entities from older, pre-rename export files automatically. See `contentful-import`'s README "Experience Orchestration (ExO) entities" section for the import-side details.
 
+## :package: Releases
+
+[Releases](https://www.contentful.com/help/releases/) (Timeline) is a separate, GA Contentful feature — not part of Experience Orchestration, and gated by its own organization entitlement rather than `exoM1`.
+
+Releases export is on by default (`skipReleases: false`) — for the CLI and the module API alike. Pass `skipReleases: true` (`--skip-releases` on the CLI) to opt out.
+
+Only releases with `sys.schemaVersion: "Release.v2"` ("Releases") are fetched. `Release.v1` ("Launch") releases are excluded by the export query itself, since [`contentful-import`](https://github.com/contentful/contentful-import) only supports `Release.v2` on the import side.
+
+Only active Releases are exported. Archived Releases are omitted, regardless of `includeArchived`, because that option currently applies only to entries and assets.
+
+If the source space's organization lacks the Releases entitlement, or the fetch otherwise fails, a `Skipping Releases export` warning is logged and `releases` exports as an empty array — it does not fail the export.
+
+Round-trips into [`contentful-import`](https://github.com/contentful/contentful-import), which imports each release found in the exported data. See `contentful-import`'s README "Releases" section for the import-side details, including a real limitation worth knowing before you rely on this for repeated imports: Releases have no ID-preserving create, so re-importing the same export creates additional releases rather than updating existing ones.
+
 ## :warning: Limitations
 
 - This tool currently does **not** support the export of space memberships.

package/dist/index.js

@@ -80,6 +80,7 @@ function runContentfulExport(params) {
         skipWebhooks: options.skipWebhooks,
         skipRoles: options.skipRoles,
         skipTags: options.skipTags,
+        skipReleases: options.skipReleases,
         stripTags: options.stripTags,
         includeExperienceOrchestration: options.includeExperienceOrchestration,
         includeExoVariants: options.includeExoVariants,

package/dist/parseOptions.js

@@ -29,6 +29,7 @@ function parseOptions(params) {
     skipAssets: false,
     skipWebhooks: false,
     skipTags: false,
+    skipReleases: false,
     stripTags: false,
     maxAllowedLimit: 1000,
     includeExperienceOrchestration: true,
@@ -88,6 +89,7 @@ function parseOptions(params) {
     options.skipRoles = true;
     options.skipContentModel = true;
     options.skipWebhooks = true;
+    options.skipReleases = true;
   }
   options.application = options.managementApplication || `contentful.export/${_package.version}`;
   options.feature = options.managementFeature || 'library-export';

package/dist/tasks/get-space-data.js

@@ -33,6 +33,7 @@ function getFullSourceSpace({
   skipRoles,
   skipEditorInterfaces,
   skipTags,
+  skipReleases,
   stripTags,
   includeDrafts,
   includeArchived,
@@ -171,6 +172,29 @@ function getFullSourceSpace({
       });
     }),
     skip: () => skipRoles || environmentId !== 'master' && 'Roles can only be exported from master environment'
+  }, {
+    title: 'Fetching Releases data',
+    task: (0, _contentfulBatchLibs.wrapTask)(async ctx => {
+      try {
+        // Excludes releases created internally by other Contentful features (rather than by a
+        // user directly), so they don't leak into a customer's export as if they were
+        // user-authored Releases.
+        const releases = await cursorPagedGet(query => client.release.query({
+          environmentId,
+          spaceId,
+          query: _objectSpread({
+            'metadata.annotations.Contentful:Timeline.type[nin]': 'Staging,Hidden',
+            'sys.schemaVersion': 'Release.v2',
+            'sys.status[in]': 'active'
+          }, query)
+        }));
+        ctx.data.releases = releases;
+      } catch (err) {
+        _contentfulBatchLibs.logEmitter.emit('warning', `Skipping Releases export: ${err.message}`);
+        ctx.data.releases = [];
+      }
+    }),
+    skip: () => skipReleases
   }, {
     title: 'Fetching Design Tokens data',
     task: (0, _contentfulBatchLibs.wrapTask)(async ctx => {

package/dist/usageParams.js

@@ -57,6 +57,10 @@ var _default = exports.default = _yargs.default.version(_package.default.version
   describe: 'Skip exporting webhooks',
   type: 'boolean',
   default: false
+}).option('skip-releases', {
+  describe: 'Skip exporting Releases',
+  type: 'boolean',
+  default: false
 }).options('strip-tags', {
   describe: 'Untag assets and entries',
   type: 'boolean',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contentful-export",
-  "version": "8.4.0",
+  "version": "8.5.0",
   "description": "this tool allows you to export a space to a JSON dump",
   "main": "dist/index.js",
   "types": "types.d.ts",