diff --git a/.gitignore b/.gitignore index 3ba21992..a91a9f31 100644 --- a/.gitignore +++ b/.gitignore @@ -49,3 +49,4 @@ firebase-debug.*.log* # cypress videos *.mp4 +*.mp4.meta diff --git a/CHANGELOG.md b/CHANGELOG.md index 5eb15c48..de5190e6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,8 @@ # CHANGELOG -## Not released +## Unreleased + +## 1.0.0-rc.2 (2021-03-12) - Add improved htmlForFeature in skeleton [#215](https://github.com/CartoDB/carto-react-template/pull/215) - Fix immutable/serializable checks for redux middleware in skeleton [#216](https://github.com/CartoDB/carto-react-template/pull/216) diff --git a/DEVELOPERS.md b/DEVELOPERS.md index 4d887c8b..70eb3d84 100644 --- a/DEVELOPERS.md +++ b/DEVELOPERS.md @@ -28,14 +28,30 @@ npx create-react-app test-template --template file:./carto-react-template/templa ## Publishing the templates to npm -> ⚠️ Important: remember to set the right version for each template, tag the release in the GitHub repository and deploy the sample app with the latest changes - -For each template, execute the release command from its **base folder**. Before this command is executed, a pre-hook will clean all unnecesary development files and folders and copy the hygen templates, before making the npm release +Follow these steps: + +1. Open a new branch for the release, eg. release-v1.0.0-rc.2 +2. For each template: + - launch the app, with `yarn start` + - test cypress locally, with `yarn cy:run` + - manual review from browser (see errors & warnings) + - from template root folder `yarn clean` + - use create-react-app to build a project + - test cra project result as a user, including hygen generators +3. Bump manually package version in package.json (root level --> package.json & inside template --> package.dev.json) +4. Update changelog: rename 'Unrelased' to new version, eg 1.0.0-rc.2 (2021-03-12) +5. Push branch to remote to run CI (all test green) +6. Execute the release command, for each template, from its **base folder**: `yarn release`. ```bash -cd template-sample-app -yarn release + cd template-sample-app + yarn release ``` +Before this command is executed, a prerelease hook will clean all unnecesary development files and folders and copy the latest hygen templates, before making the npm release. +7. After a succesful release, merge the PR and create a tag in github +8. Deploy the sample app template to firebase (if required) + + ## Deploying the sample app diff --git a/template-sample-app/package.json b/template-sample-app/package.json index 9933ca06..31bfacd1 100644 --- a/template-sample-app/package.json +++ b/template-sample-app/package.json @@ -1,6 +1,6 @@ { "name": "@carto/cra-template-sample-app", - "version": "1.0.0-rc.1", + "version": "1.0.0-rc.2", "keywords": [ "react", "create-react-app", diff --git a/template-sample-app/template/package.dev.json b/template-sample-app/template/package.dev.json index 8fc4b095..ff41b34e 100644 --- a/template-sample-app/template/package.dev.json +++ b/template-sample-app/template/package.dev.json @@ -1,6 +1,6 @@ { "name": "carto-for-react", - "version": "1.0.0-rc.1", + "version": "1.0.0-rc.2", "private": true, "dependencies": { "@carto/react-api": "1.0.0-rc.1", diff --git a/template-skeleton/package.json b/template-skeleton/package.json index 0aba2dfd..ed3f3342 100644 --- a/template-skeleton/package.json +++ b/template-skeleton/package.json @@ -1,6 +1,6 @@ { "name": "@carto/cra-template", - "version": "1.0.0-rc.1", + "version": "1.0.0-rc.2", "keywords": [ "react", "create-react-app", diff --git a/template-skeleton/template/package.dev.json b/template-skeleton/template/package.dev.json index 8fc4b095..ff41b34e 100644 --- a/template-skeleton/template/package.dev.json +++ b/template-skeleton/template/package.dev.json @@ -1,6 +1,6 @@ { "name": "carto-for-react", - "version": "1.0.0-rc.1", + "version": "1.0.0-rc.2", "private": true, "dependencies": { "@carto/react-api": "1.0.0-rc.1",