Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dieproduktmacher/contentful-tooling
Collection of useful packages for easier and standardised integration of Contentful based web applications
https://github.com/dieproduktmacher/contentful-tooling
cli contentful migrations-runner
Last synced: about 1 month ago
JSON representation
Collection of useful packages for easier and standardised integration of Contentful based web applications
- Host: GitHub
- URL: https://github.com/dieproduktmacher/contentful-tooling
- Owner: DieProduktMacher
- License: mit
- Created: 2023-09-07T16:21:10.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-16T18:25:34.000Z (10 months ago)
- Last Synced: 2024-11-28T09:44:17.868Z (about 1 month ago)
- Topics: cli, contentful, migrations-runner
- Language: TypeScript
- Homepage: https://www.dieproduktmacher.com/
- Size: 26.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
DPM Contentful Tooling
## About The Project
This repository is used as a collection for useful contentful tools. The first tool added, is a migration tool to support schema creation in CI/CD.
## Getting Started
### Prerequisites
- Make sure [Node.js](https://nodejs.org/) (>= v18) and NPM [NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) is installed
- Set up / Access to a [Contentful](https://www.contentful.com/) space with read / write permissions
### Setup
1. Clone this repository
2. Run `npm install` on **root level** (it's a monorepo using [npm workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces))
1. Create a new `.env` file based on the `.env.sample` file from the root folder of this repo and add your contentful credentials:
```
CONTENTFUL_SPACE = **SPACE_ID**
CONTENTFUL_MANAGEMENT_TOKEN = **PERSONAL_ACCESS_TOKEN**
```
#### Troubleshooting
- [How to generate personal tokens (Contentful-Managment-Token)](https://www.contentful.com/developers/docs/references/authentication/#getting-a-personal-access-token)
- [How to find contentful space ID](https://www.contentful.com/help/find-space-id/)
### Usage
#### Migration Tool (Contentful Schema CI/CD)
Run the migration tool via `npm run migration-tool ` with the following argument options:
`deployProd`deploy new version of production environment by running all new migrations
`deployStage`run new migrations on the current staging environment
`ciTestMigrations`test new migrations by running them against a new temporary ci environment
`resetStage`delete the contents of the stage environment and reset it to the state of the current master environment
`createMigration `create a new migration file
`diffContentTypes `compares the content types of `environment1` with `environment2` based on a `JSON` file comparison
`generateTypeDefinitions `generates typescript types from all content types in the given `environment`. Types based on [contentful.js](https://github.com/contentful/contentful.js) library types.
`listEnvironments`list all available environments
##### How to test if everything is set up correctly?
To test the the migration tool is setup correctly and is connected to the contentful space, you can run `npm run migration-tool listEnvironments` and you should see a table with all created environments on your contentful space.
## Roadmap
**Order** of the following list does not necessarily represent prioritization
### Migrations
- Publish as installable / executable NPM package
- Make it backwards compatibility with Contentful CLI < 10
- Add example migrations based on commonly used content types, e.g. Page Metadata, CTA, Accordeon, Tabs, MediaWrapper
- Create a documentation page
- Generalise deploy{Env} / reset{Env} scripts
### Other packages
- Add CSV (Excel, Numbers) to JSON Converter for content imports
## Contact
DieProduktmacher GmbH
Hofmannstraße 7a
81379 Munich
E-Mail: [code[at]produktmacher.com](mailto:[email protected])
Website: [www.dieproduktmacher.com](https://www.dieproduktmacher.com)