|
1 | 1 | # Automatic update of the package_index.json file for release management |
2 | 2 |
|
| 3 | +Tools for a simple release management system. |
| 4 | + |
| 5 | +Mimimizing the amount of manual work needed for generating the board manager |
| 6 | +release files hopefully minimizes the number of errors and allows for |
| 7 | +frequent releases. |
| 8 | + |
| 9 | + |
| 10 | +## Quick checklist for release |
| 11 | + |
| 12 | +- Update the version number for the updated components in `Makefile`. |
| 13 | +- `make` |
| 14 | +- `make upload`: test on local test server |
| 15 | +- Check Changelog. No need to update the version number. |
| 16 | +- `make release`: Update version number in changelog, commit generated |
| 17 | + files, tag the new release. |
| 18 | +- release message on github and attach the files in release/<VERSION>/ |
| 19 | + |
| 20 | + |
| 21 | + |
| 22 | +## How to prepare a release |
| 23 | + |
| 24 | +The main `Makefile` defines the version numbers for the core, sdcc and the |
| 25 | +tools. Update the version number for the component you would like to |
| 26 | +re-generate and run `make`. |
| 27 | + |
| 28 | +It is helpful to really edit the Makefile and save the new version numbers |
| 29 | +to the repository on every release. This will make sure that all |
| 30 | +dependencies are up-to-date the next time and will prevent the system from |
| 31 | +using references to old versions. |
| 32 | + |
| 33 | +After testing, check in the newly generated files and update the Changelog: |
| 34 | + |
| 35 | + make release |
| 36 | + |
| 37 | + |
| 38 | +For testing purposes only (!!), it is possible to use the simpler systax |
| 39 | +using makefile variables on the command line: |
| 40 | + |
| 41 | + make COREVERSION=0.3.2 core |
| 42 | + |
| 43 | +will generate a fresh archive for the core files and update the package file |
| 44 | +accordingly. |
| 45 | + |
| 46 | + |
| 47 | +## Supporting tools |
| 48 | + |
3 | 49 | `assemble.sh`: Insert all objects from parts/ directory in the platform and |
4 | 50 | tools field of the json template file to assemble the final package file. |
5 | 51 |
|
|
0 commit comments