@servicetitan/docs-uikit 32.2.0 → 32.3.0
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/docs/startup/install.mdx
CHANGED
|
@@ -17,14 +17,24 @@ See [package.json in the example project](https://github.com/search?q=repo%3Aser
|
|
|
17
17
|
|
|
18
18
|
## Options
|
|
19
19
|
|
|
20
|
-
| Option | Description
|
|
21
|
-
| :----------- |
|
|
22
|
-
| `--no-token` |
|
|
20
|
+
| Option | Description |
|
|
21
|
+
| :----------- | :----------------------------------------------------------------------- |
|
|
22
|
+
| `--no-token` | Only install dependencies. Don't configure the npm authentication token. |
|
|
23
|
+
| `--token` | Only configure the npm authentication token. Don't install dependencies. |
|
|
23
24
|
|
|
24
25
|
## Configuring NPM Token in Development
|
|
25
26
|
|
|
26
27
|
In development environments, `startup install` automatically configures an npm authentication token that grants access to private ServiceTitan packages. It securely retrieves the token and updates your npm configuration so you can install dependencies without any further setup.
|
|
27
28
|
|
|
29
|
+
:::tip
|
|
30
|
+
If your project is using `startup` v31 or earlier, or isn't using `startup` at all, run this command to manually configure the npm authentication token.
|
|
31
|
+
|
|
32
|
+
```
|
|
33
|
+
npx --yes @servicetitan/startup@latest install --token
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
:::
|
|
37
|
+
|
|
28
38
|
:::caution
|
|
29
39
|
`startup install` detects if it is running in development by checking for standard environment variables set by CI systems (e.g.,`CI` and `TEAMCITY_VERSION`). If none of these variables are set, it assumes it is running on a developer machine.
|
|
30
40
|
If it mistakes a CI environment for a developer machine, add a `CI` environment variable (with any value) to the workflow, or [use `--no-token`](#how-to-use---no-token) to disable configuring the npm token.
|
|
@@ -119,7 +129,7 @@ These instructions are only for projects using [Option 2](#option-2-use-environm
|
|
|
119
129
|
|
|
120
130
|
If your project is [using an environment variable](#option-2-use-environment-variable), and it isn't using `startup` v32 or later, then developers must also defined the same environment variable manually. And they must repeat these steps each time the token is rotated,
|
|
121
131
|
|
|
122
|
-
1. Run `npx --yes @servicetitan/startup@latest install` to add the token to your per-user configuration.
|
|
132
|
+
1. Run `npx --yes @servicetitan/startup@latest install --token` to add the token to your per-user configuration.
|
|
123
133
|
2. Run `npm config get userconfig` to get the location of your per-user configuration file.
|
|
124
134
|
3. Find the token in the configuration file, on the line that starts `//registry.npmjs.org/:_authToken=`
|
|
125
135
|
4. Create a local environment variable with the token. Use the same variable name as in project's `.npmrc`.
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: mfe-list
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
Lists published MFE packages.
|
|
6
|
+
|
|
7
|
+
Use `mfe-list` to see what MFE versions were published and when.
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
npx startup mfe-list
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
It outputs, for each MFE in the current workspace,
|
|
14
|
+
|
|
15
|
+
- The MFE's name, current version, and total number of versions
|
|
16
|
+
- A table listing the 20 most recently published versions, with the following columns:
|
|
17
|
+
- **Version** : the published version
|
|
18
|
+
- **Tag** : assigned tag (if any)
|
|
19
|
+
- **When** : when the version was published, relative to the current time
|
|
20
|
+
|
|
21
|
+
For example,
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
@servicetitan/examples | version: 0.0.0-far1369uploadsourcemaps.8e4f1ca0 | versions: 20
|
|
25
|
+
┌────────────────────────────────────────┬─────────┬───────────────┐
|
|
26
|
+
│ Version │ Tag │ When │
|
|
27
|
+
├────────────────────────────────────────┼─────────┼───────────────┤
|
|
28
|
+
│ 0.0.0-far1369uploadsourcemaps.8e4f1ca0 │ latest │ 2 months ago │
|
|
29
|
+
├────────────────────────────────────────┼─────────┼───────────────┤
|
|
30
|
+
│ 0.0.0-test.7cf27f80 │ │ 3 months ago │
|
|
31
|
+
├────────────────────────────────────────┼─────────┼───────────────┤
|
|
32
|
+
│ 0.0.0-test.2c98b704 │ │ 3 months ago │
|
|
33
|
+
|
|
34
|
+
~ ~
|
|
35
|
+
~ ~
|
|
36
|
+
├────────────────────────────────────────┼─────────┼───────────────┤
|
|
37
|
+
│ 0.0.3 │ │ 4 years ago │
|
|
38
|
+
├────────────────────────────────────────┼─────────┼───────────────┤
|
|
39
|
+
│ 1.2.4 │ │ 4 years ago │
|
|
40
|
+
└────────────────────────────────────────┴─────────┴───────────────┘
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Options
|
|
44
|
+
|
|
45
|
+
| Option | Description |
|
|
46
|
+
| :---------------- | :------------------------------------------------------------------ |
|
|
47
|
+
| `--all` | List all published versions. |
|
|
48
|
+
| `--ignore <glob>` | Exclude MFEs with names matching the given glob pattern. |
|
|
49
|
+
| `--limit <count>` | List the last `<count>` published versions. Ignores `<count> <= 0`. |
|
|
50
|
+
| `--tagged` | List only tagged versions. |
|
|
51
|
+
|
|
52
|
+
## Listing specific MFEs
|
|
53
|
+
|
|
54
|
+
To list specific MFEs, pass their package names on the command line. For example, to list all tagged versions of `@servicetitan/dispatch-center` run,
|
|
55
|
+
|
|
56
|
+
```
|
|
57
|
+
npx startup mfe-list @servicetitan/dispatch-center --tagged
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
:::tip
|
|
61
|
+
Use this syntax to list any MFE, not just the ones in the project workspace.
|
|
62
|
+
:::
|
|
63
|
+
|
|
64
|
+
## Authorization
|
|
65
|
+
|
|
66
|
+
If the machine is not authorized to access [Verdaccio](/docs/frontend/verdaccio-unpkg/#verdaccio), `startup` prompts you to authorize it. E.g.,
|
|
67
|
+
|
|
68
|
+
```sh
|
|
69
|
+
$ npx startup mfe-list
|
|
70
|
+
This machine is not authorized to access https://verdaccio.servicetitan.com. Authorize? [Y/n]
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Enter `y` to confirm, or `n` to cancel. If you confirm, `startup` runs [verdaccio-okta-oauth](/docs/frontend/verdaccio-unpkg/#authorzation) then proceeds with the command.
|
package/docs/startup/startup.mdx
CHANGED
|
@@ -29,6 +29,7 @@ Updating build tooling is typically a daunting and time-consuming task. When new
|
|
|
29
29
|
- [install](./install) install project dependencies
|
|
30
30
|
- [kendo-ui-license](./kendo-ui-license) install KendoReact license key
|
|
31
31
|
- [lint](./lint) run eslint and stylelint
|
|
32
|
+
- [mfe-list](./mfe-list) list published MFE packages
|
|
32
33
|
- [mfe-publish](./mfe-publish) publish or unpublish MFE packages
|
|
33
34
|
- [review](./review) check project for configuration errors
|
|
34
35
|
- [start](./start) run project in development mode
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@servicetitan/docs-uikit",
|
|
3
|
-
"version": "32.
|
|
3
|
+
"version": "32.3.0",
|
|
4
4
|
"description": "",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -16,5 +16,5 @@
|
|
|
16
16
|
"cli": {
|
|
17
17
|
"webpack": false
|
|
18
18
|
},
|
|
19
|
-
"gitHead": "
|
|
19
|
+
"gitHead": "201392862b3cb12500b3c8c4f6310b101b87201b"
|
|
20
20
|
}
|