This project was bootstrapped with Create React App.
We use semantic release to generate each tag for automatic versioning, that's why it's important to have each commit formatted correctly, this tool uses Angular commit message format by default that uses conventional commits.
The format is the following:
<type>(<scope>): <short summary>
The types we most use are:
- docs: Documentation only changes
- feat: A new feature (this triggers a new tag and deploys inmediately)
- fix: A bug fix (this triggers a new tag and deploys inmediately)
- chore: a task (this does not generate a new version tag)
- test: Adding missing tests or correcting existing tests
Some examples:
fix(login): fix a typo in main title
feat(reports): add new GDPR report
chore: update component version
Each time a PR is made CI is run, to see a full detail check DockerFile.
What is run in CI?
- prettier
- eclint
- tests
- temporal version generation
As a result of running CI, a temporal version of the code is published into CDN marked with a build number.
To check the build number in the second check marked in each PR, while hovering in details the version is as marked in the image below.
Then a build code link with build number 2962 can be formatted as follows for all enviroments:
-
Production: https://cdn.fromdoppler.com/doppler-webapp/build2962/#/login
-
Integration: https://cdn.fromdoppler.com/doppler-webapp/int-build2962/#/login
-
QA: https://cdn.fromdoppler.com/doppler-webapp/qa-build2962/#/login
-
Demo: https://cdn.fromdoppler.com/doppler-webapp/demo-build2962/#/login Demo is like a local copy hosted into CDN (it uses doubles and no real data).
-
Development: https://cdn.fromdoppler.com/doppler-webapp/demo-build2962/#/login Development is code that points to local Doppler (It is needed to have local Doppler copy running for this to work).
In this project we have include PR size, as a way to measure how much is small. Right now we tend to make size M or L PRs and that's our size for small.
We try to use vertical slicing or partial functionalities to keep our PRs small enough to be easily understood.
To make our PRs small sometimes is useful to upload hidden functionality. This can be done by using the dopplerExperimental component.
const PermissionExpandableRow = ({ dependencies: { experimentalFeatures } }) => {
...
const isPermissionHistoryEnabled =
experimentalFeatures && experimentalFeatures.getFeature('PermissionHistory');
...
return (
<>
<tr>
<td>
<span className="dp-name-text">
{isPermissionHistoryEnabled && (
<button>
...To make use of this feature by console it can be enabled like this:
localStorage.setItem('dopplerExperimental', JSON.stringify({PermissionHistory: true}));
In the project directory, you can run:
yarn install
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
Note: this is a one-way operation. Once you eject, you can’t go back!
If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.