studiokit-scaffolding-js 4.11.2 → 4.11.3
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 +16 -9
- package/lib/constants/mockData.d.ts +2 -0
- package/lib/constants/mockData.js +2 -1
- package/lib/types/User.d.ts +1 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -86,25 +86,32 @@ Components and utils can be imported from `studiokit-scaffolding-js/lib/...`
|
|
|
86
86
|
## Branches
|
|
87
87
|
|
|
88
88
|
1. Create a new branch
|
|
89
|
-
* **
|
|
90
|
-
* **
|
|
91
|
-
1. Update the version number
|
|
92
|
-
*
|
|
89
|
+
* **Feature/Issue**: In GitLab from an issue, create a branch off of `develop`
|
|
90
|
+
* **Hotfix**: Create a `hotfix` branch off of `master` (manually or in GitLab by making an MR)
|
|
91
|
+
1. Update the version number
|
|
92
|
+
* **Feature/Issue**
|
|
93
|
+
* append `-next.1.1`
|
|
94
|
+
* e.g. If the current version is `1.0.0`, the new branch should be `1.0.0-next.1.1`
|
|
95
|
+
* **Hotfix**
|
|
96
|
+
* increase the version number and append `-alpha.1`
|
|
97
|
+
* e.g. If the current version is `1.0.0`, the new branch should be `1.0.1-alpha.1` for hotfix
|
|
93
98
|
* **NOTE:** if **more than one** branch is being developed on at the same time, simply increment the **first** number after "next"
|
|
94
99
|
* e.g. `1.0.0-next.2.1` for the second issue branch (this won't apply for hotfixes)
|
|
95
100
|
1. Development Loop
|
|
96
101
|
1. Add/update new components, utils, or styles
|
|
97
102
|
1. Add/update unit tests for those components or utils to confirm basic functionality
|
|
98
|
-
1. Increment the **last** number in the version
|
|
103
|
+
1. Increment the **last** number in the version
|
|
104
|
+
* e.g. `1.0.0-next.2.1` => `1.0.0-next.2.2` for a feature/issue branch
|
|
105
|
+
* e.g. `1.0.1-alpha.1` => `1.0.1-alpha.2` for a hotfix branch
|
|
99
106
|
1. Push to gitlab. Azure DevOps will run a pipeline and publish this version to npmjs.org
|
|
100
107
|
1. Install the new version in the project(s) you are working on by updating its `package.json` and running `yarn`
|
|
101
108
|
1. Repeat as needed
|
|
102
109
|
1. Merging
|
|
103
|
-
* After the Merge Request is approved, **remove** the "next" or "alpha" suffix from the version **before** merging
|
|
104
|
-
* For **hotfix** branches,
|
|
110
|
+
* After the Merge Request is approved, **remove** the "next" or "alpha" suffix from the version **before** merging to develop or master
|
|
111
|
+
* For **hotfix** branches, the version number should be the new patch number, e.g. `1.0.1`
|
|
105
112
|
1. Release
|
|
106
|
-
* **
|
|
107
|
-
* **
|
|
113
|
+
* **Feature/Issue**: After merging, create a new "release" branch from `develop` and follow the "git flow" release steps as normal
|
|
114
|
+
* **Hotfix**: Finish the "git flow" hotfix steps as normal from the hotfix branch
|
|
108
115
|
* Azure DevOps will run a pipeline to publish the version merged to `master` to npmjs.org
|
|
109
116
|
|
|
110
117
|
## Styles
|
|
@@ -33,6 +33,7 @@ export declare const defaultNamelessUserInfo: {
|
|
|
33
33
|
dateStored: string;
|
|
34
34
|
dateLastUpdated: string;
|
|
35
35
|
isImpersonated: boolean;
|
|
36
|
+
lockDownBrowserTestLaunchUrl: string | null;
|
|
36
37
|
id: string;
|
|
37
38
|
firstName: string | null;
|
|
38
39
|
lastName: string | null;
|
|
@@ -53,6 +54,7 @@ export declare const defaultNamedUserInfo: {
|
|
|
53
54
|
dateStored: string;
|
|
54
55
|
dateLastUpdated: string;
|
|
55
56
|
isImpersonated: boolean;
|
|
57
|
+
lockDownBrowserTestLaunchUrl: string | null;
|
|
56
58
|
id: string;
|
|
57
59
|
email: string | null;
|
|
58
60
|
_metadata?: import("studiokit-net-js").Metadata | undefined;
|
|
@@ -89,7 +89,8 @@ exports.defaultUser = {
|
|
|
89
89
|
careerAccountAlias: null,
|
|
90
90
|
employeeNumber: null,
|
|
91
91
|
userName: 'test',
|
|
92
|
-
puid: null
|
|
92
|
+
puid: null,
|
|
93
|
+
lockDownBrowserTestLaunchUrl: null
|
|
93
94
|
}
|
|
94
95
|
};
|
|
95
96
|
exports.defaultNamelessUserInfo = __assign(__assign({}, exports.defaultUser.userInfo), {
|
package/lib/types/User.d.ts
CHANGED
package/package.json
CHANGED