Skip to content

Commit ca18298

Browse files
docs: improvement release documentation
1 parent d5698ea commit ca18298

1 file changed

Lines changed: 24 additions & 5 deletions

File tree

README.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ pseudolocale --string 'This is going to be pseudolocalized %token%.'
4040
```
4141

4242
example.json
43+
4344
```json
4445
{
4546
"string1": "this is the first string",
@@ -53,6 +54,7 @@ pseudolocale --readFile example.json --writeFile example-pseudo.json
5354
```
5455

5556
example-pseudo.json
57+
5658
```json
5759
{
5860
"string1": "[!!ţĥĩş ĭś ťĥě ƒĩŗśŧ şţřįƞĝ!!]",
@@ -160,14 +162,31 @@ npm test
160162

161163
## Release new version
162164

163-
1. change version in package.json
165+
1. Run tests to ensure everything is working:
166+
167+
```bash
168+
npm test
169+
```
170+
171+
2. Bump the version (patch, minor, or major). This will update `package.json`, `package-lock.json`, and create a git commit and tag:
172+
173+
```bash
174+
npm version patch
175+
# or npm version minor
176+
# or npm version major
177+
```
178+
179+
3. Push the commit and tags to the repository:
180+
181+
```bash
182+
git push --follow-tags
183+
```
184+
185+
4. Publish to npm (this will automatically run the build script):
164186

165-
2. Publish to npm
166187
```bash
167188
npm login
168189
npm publish
169190
```
170191

171-
3. Push `package.json` & `package-lock.json` to origin.
172-
4. Go to GitHub releases https://github.com/MartinCerny-awin/pseudolocale/releases and create new release
173-
192+
5. Go to GitHub releases https://github.com/MartinCerny-awin/pseudolocale/releases and create a new release from the new tag

0 commit comments

Comments
 (0)