@unicef/material-ui 0.8.0 → 0.9.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -0
- package/lib/dev.js +389 -70
- package/lib/dev.js.map +1 -1
- package/lib/prod.js +389 -70
- package/lib/prod.js.map +1 -1
- package/package.json +17 -7
package/README.md
CHANGED
|
@@ -99,7 +99,37 @@ Builds the styleguide docs as well as the example. The output is stored in `site
|
|
|
99
99
|
|
|
100
100
|
Runs `npm run build:site` and then deploys the output to Github `gh-pages`.
|
|
101
101
|
|
|
102
|
+
To deploy from a clean repo
|
|
103
|
+
```bash
|
|
104
|
+
git clone https://unicef.github.io/unicef-material-ui/
|
|
105
|
+
cd unicef-material-ui
|
|
106
|
+
npm install
|
|
107
|
+
npm build
|
|
108
|
+
cd example
|
|
109
|
+
npm install
|
|
110
|
+
cd ..
|
|
111
|
+
npm deploy
|
|
112
|
+
```
|
|
102
113
|
|
|
114
|
+
## Release a new version in npm registry
|
|
115
|
+
|
|
116
|
+
There is a Github action (pipeline) that automatically releases in npm whenever a release is created.
|
|
117
|
+
To create a release, previously you need to ensure the version is changed in packages.json and then create a tag in the repository. These are the steps:
|
|
118
|
+
|
|
119
|
+
1. Get the latest `master`
|
|
120
|
+
2. Edit `packages.json` and increase the version number and save to origin/master.
|
|
121
|
+
```bash
|
|
122
|
+
# After editing packages.json
|
|
123
|
+
git commit -m "bump version x.y.z"
|
|
124
|
+
git push origin master
|
|
125
|
+
```
|
|
126
|
+
3. Create a tag and push it to master:
|
|
127
|
+
```bash
|
|
128
|
+
git tag releases/vX.Y.Z # where X.Y.Z is a semver number such as 1.6.9
|
|
129
|
+
git push origin tags
|
|
130
|
+
```
|
|
131
|
+
4. Then in the GitHub web interface create the release. The action will be automatically triggered.
|
|
132
|
+
|
|
103
133
|
## About UNICEF
|
|
104
134
|
|
|
105
135
|
[UNICEF](https://www.unicef.org/) works in over 190 countries and territories to protect the rights of every child. UNICEF has spent more than 70 years working to improve the lives of children and their families. In UNICEF, **we believe all children have a right to survive, thrive and fulfill their potential – to the benefit of a better world**.
|