|
1 | | - |
2 | 1 | # Developer notes |
3 | 2 |
|
4 | 3 | To develop for a template itself, you need to create a `package.json` file in the template folder and add it to the gitignore list, as this file would overwrite the one created by create-react-app when used. This is as easy as follows: |
@@ -32,31 +31,22 @@ Follow these steps: |
32 | 31 |
|
33 | 32 | 1. Open a new branch for the release from master, eg. `git checkout -b release-v1.0.0-rc.3` |
34 | 33 | 2. For each template: |
35 | | - - remove the link to @carto/react-* packages with `yarn unlink-carto-react` |
36 | | - - ensure latest references with `yarn`. Delete previously node_modules if you feel a bit unsure :) |
37 | | - - launch the app, with `yarn start` |
38 | | - - test cypress locally, with `yarn cy:run` |
39 | | - - manual review from browser (see errors & warnings) |
40 | | - - from template root folder (eg. template-skeleton), run `yarn clean` |
41 | | - - copy the hygen templates, so you can test them inside the client project |
42 | | - - use create-react-app to build a project |
43 | | - - test cra project result as a user, including hygen generators |
44 | | -3. Bump manually package version in package.json (root level --> package.json & inside template --> package.dev.json), checking @carto/react-* package versions are also correct. |
| 34 | + - remove the link to @carto/react-\* packages with `yarn unlink-carto-react` |
| 35 | + - ensure latest references with `yarn`. Delete previously node_modules if you feel a bit unsure :) |
| 36 | + - launch the app, with `yarn start` |
| 37 | + - test cypress locally, with `yarn cy:run` |
| 38 | + - manual review from browser (see errors & warnings) |
| 39 | + - from template root folder (eg. template-skeleton), run `yarn clean` |
| 40 | + - copy the hygen templates, so you can test them inside the client project |
| 41 | + - use create-react-app to build a project |
| 42 | + - test cra project result as a user, including hygen generators |
| 43 | +3. Bump manually package version in package.json (root level --> package.json & inside template --> package.dev.json), checking @carto/react-\* package versions are also correct. |
45 | 44 | 4. Update changelog: rename 'Unrelased' to new version, eg 1.0.0-rc.3 (2021-03-23) |
46 | 45 | 5. Push branch to remote to run CI (all test green) with `git push` |
47 | | -6. Execute the release command, for each template, from its **base folder** (eg. template-sample-app): `yarn release`. |
48 | | - |
49 | | -```bash |
50 | | - cd template-sample-app |
51 | | - yarn release |
52 | | -``` |
53 | | -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. |
| 46 | +6. Execute the release command, for each template, from its **base folder** (eg. template-sample-app): `yarn publish:prerelease` or `yarn publish:release`. Before the npm publication, a prepare-release script will clean all unnecesary development files and folders and copy the latest hygen templates. |
54 | 47 | 7. After a succesful release, merge the PR and create a tag in github |
55 | 48 | 8. Deploy the sample app template to firebase (if required) |
56 | 49 |
|
57 | | - |
58 | | - |
59 | | - |
60 | 50 | ## Deploying the sample app |
61 | 51 |
|
62 | 52 | The sample app corresponding to https://sample-app-react.carto.com/ is hosted in Firebase, so before deploying it you'll need to log into Firebase using: |
|
0 commit comments