Skip to content

Commit c60e23d

Browse files
committed
chore: add more publishing scripts info
1 parent 0c2a7e1 commit c60e23d

File tree

1 file changed

+24
-15
lines changed

1 file changed

+24
-15
lines changed

scripts.md

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,30 @@ This script builds all files needed to deploy plugins and examples to GitHub Pag
5252

5353
This script installs a beta version of Blockly, builds all files needed to deploy plugins and examples to GitHub Pages, then starts a local server with that content.
5454

55+
## Publishing scripts
56+
57+
Note that publishing via the command line is not preferred. You should
58+
use the GitHub Action workflow whenever possible, which can handle
59+
publishing all plugins as well as recovering from the partially-published
60+
state (publishing unpublished plugins only).
61+
62+
Note that none of these scripts will handle npm authentication. You need to
63+
configure an npm authentication token before you can use these scripts.
64+
65+
Full publishing documentation can be found in the internal team documentation.
66+
67+
### `npm run publish:prepare`
68+
69+
This script will clone a copy of blockly-samples to a directory called `dist`,
70+
run `npm ci`, then build and test all plugins.
71+
72+
If any plugin fails to build or some tests fail, this script should fail. Since
73+
nothing has been pushed to npm or github, you can simply correct the error and
74+
try again.
75+
76+
This script will be run automatically before any of the other publish scripts,
77+
so you do not need to run it manually first.
78+
5579
### `npm run publish:manual`
5680

5781
This script will first run `npm run publish:prepare`. It will
@@ -96,21 +120,6 @@ latest tags pulled. This is taken care of by the `publish:prepare` script.
96120

97121
## Other Scripts
98122

99-
### `npm run publish:prepare`
100-
101-
This script will clone a copy of blockly-samples to a directory called `dist`,
102-
run `npm ci`, then build and test all plugins.
103-
104-
Note that this script does not handle npm authentication. You will need to
105-
already possess a valid npm granular access token in order to publish.
106-
107-
If any plugin fails to build or some tests fail, this script should fail. Since
108-
nothing has been pushed to npm or github, you can simply correct the error and
109-
try again.
110-
111-
This script will be run automatically before any of the other publish scripts,
112-
so you do not need to run it manually first.
113-
114123
### `npm run deploy:prepare`
115124

116125
This script prepares each of the plugins for deployment. In general, the script

0 commit comments

Comments
 (0)