@veeqo/ui 0.1.19 → 0.1.20
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 +22 -21
- package/dist/index.esm.js +1 -1
- package/dist/index.esm.js.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -35,12 +35,27 @@ You will need to install [ESlint](https://marketplace.visualstudio.com/items?ite
|
|
|
35
35
|
|
|
36
36
|
## Publishing to NPM
|
|
37
37
|
|
|
38
|
-
_We currently deploy to NPM,
|
|
38
|
+
_We currently deploy to NPM, which is an automated process once you merge._
|
|
39
|
+
|
|
40
|
+
### Publishing
|
|
41
|
+
|
|
42
|
+
Versioning will happen on the `package.json` version number, and is for the library as a whole instead of per component for simplicity.
|
|
43
|
+
|
|
44
|
+
When have made a change you want published, use `npm run patch` or `npm run minor` or `npm run major` depending on your changes:
|
|
45
|
+
|
|
46
|
+
- This create update the version number by the amount specified in the command you entered above.
|
|
47
|
+
- **Create a git tag** for that version, making the version history straightward to look back on.
|
|
48
|
+
- Update the changelog based on your commits.
|
|
49
|
+
- Push this readme change upstream
|
|
50
|
+
|
|
51
|
+
After this is done, merge your PR and GitHub actions will do the rest! If your version hasn't deployed within a few mins ([check here](https://www.npmjs.com/package/@veeqo/ui?activeTab=versions)), please reach out on slack.
|
|
39
52
|
|
|
40
53
|
<details>
|
|
41
|
-
<summary>
|
|
54
|
+
<summary>To publish beta versions...</summary>
|
|
55
|
+
|
|
56
|
+
### Getting NPM Access
|
|
42
57
|
|
|
43
|
-
|
|
58
|
+
#### 1. Register NPM and request package access
|
|
44
59
|
|
|
45
60
|
In order to make sure you're not a random stranger to do the publish, you need to register your amazon account (email ending with @amazon.com) on [npm](https://www.npmjs.com/). And then create a ticket in this [system](https://t.corp.amazon.com/create) to request you permission to access Veeqo-FE package, using the following options to create this access request ticket.
|
|
46
61
|
|
|
@@ -57,7 +72,7 @@ Access Requests
|
|
|
57
72
|
|
|
58
73
|
Ps: feel free to PM your manager about your access request too as sometimes they may miss the emails
|
|
59
74
|
|
|
60
|
-
|
|
75
|
+
#### 2. Authenticate
|
|
61
76
|
|
|
62
77
|
Once you've granted the access to Veeqo-FE package, make sure you have authenticated NPM and logged in with your account on your local machine.
|
|
63
78
|
|
|
@@ -67,22 +82,8 @@ An easy way to do this is to run:
|
|
|
67
82
|
npm login
|
|
68
83
|
```
|
|
69
84
|
|
|
70
|
-
|
|
85
|
+
### Creating
|
|
71
86
|
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
Versioning will happen on the `package.json` version number, and is for the library as a whole instead of per component for simplicity.
|
|
75
|
-
|
|
76
|
-
When have made a change you want published, use `npm run patch` or `npm run minor` or `npm run major` depending on your changes:
|
|
77
|
-
|
|
78
|
-
- This create update the version number by the amount specified in the command you entered above.
|
|
79
|
-
- **Create a git tag** for that version, making the version history straightward to look back on.
|
|
80
|
-
- Update the changelog based on your commits.
|
|
81
|
-
- Push this readme change upstream
|
|
87
|
+
Publish off your branch, don't merge to master. Adjust the package.lock version number yourself before publishing and make sure to publish with a tag (to not update `latest`).
|
|
82
88
|
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
Once your PR is reviewed and merged, you can then run `npm publish` from master.
|
|
86
|
-
|
|
87
|
-
- This will run all unit tests and check linting.
|
|
88
|
-
- Then publish to NPM.
|
|
89
|
+
</details>
|