This project was bootstrapped with Create React App. Thus you can use the usual scripts. However this repo rather focuses on the CI/CD set up, having a changelog generated, etc.
This repo was built with step-by-step commits, so if you read through CHANGELOG.md (on master branch) each
commit describing a new feature, so it should be easy to reproduce.
- A Create React App project is inside the src/ but that should be replaced by any type of FE project. So this is optional, just there to be able to build the project.
- Commitlint is ensuring that every commit msg. follows the same conventions
- Semantic release is ensuring every time a
develop -> mastermerge happens we auto-generate aCHANGELOG.mdand also updating thepackage.jsonwith the correct version number. - Github Actions used for simplified install + build + test stages on
developandmasterbranches. - Surge.sh used for quick and hassle-free deployment for the frontend project
- The repo following
developandmasterbranch conventions defined here and absolutely resonates with the following ideas:
When the source code in the develop branch reaches a stable point and is ready to be released, all of the changes should be merged back into master somehow and then tagged with a release number. How this is done in detail will be discussed further on.
Therefore, each time when changes are merged back into master, this is a new production release by definition. We tend to be very strict at this, so that theoretically, we could use a Git hook script to automatically build and roll-out our software to our production servers everytime there was a commit on master.
So this is exactly what this repo is about, to implement the mentioned steps