Skip to content

Commit e4c7f9f

Browse files
committed
docs: update README
1 parent dc5deb8 commit e4c7f9f

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Required environment variables:
2626
- `VSCE_PAT` - VS Code Marketplace personal access token
2727
- `OVSX_PAT` - OpenVSX registry personal access token
2828

29-
For local development, follow the vsce and ovsx documentation to set up personal access tokens. For CI/CD, add these as GitHub repository `secrets` or skip specific platforms.
29+
For local development, follow the [Visual Studio Marketplace](https://code.visualstudio.com/api/working-with-extensions/publishing-extension#get-a-personal-access-token) and [Open VSX Registry](https://github.com/eclipse/openvsx/wiki/Publishing-Extensions#1-create-an-access-token) documentation to set up personal access tokens. For CI/CD, add these as GitHub repository `secrets` or skip specific platforms.
3030

3131
## GitHub Actions Integration
3232

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@
1515
"url": "https://github.com/jinghaihan/vsxpub/issues"
1616
},
1717
"keywords": [
18-
"cli",
18+
"vscode",
1919
"vscode-extensions",
20+
"vsx",
2021
"publish"
2122
],
2223
"exports": {

src/cli.ts

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ try {
3939
const skipOvsx = !config.include.includes('ovsx')
4040

4141
if (skipGit && skipVsce && skipOvsx) {
42-
console.error(c.red('No platforms to publish to.'))
42+
console.error(c.red('Please specify at least one platform to publish to.'))
4343
process.exit(1)
4444
}
4545

@@ -100,7 +100,7 @@ async function execCommand(cmd: string, args: string[], config: PublishOptions)
100100

101101
async function createPackage(config: PublishOptions) {
102102
const args = normalizeArgs(['vsce', 'package'], config)
103-
return await tryExec({
103+
return await executeWithFeedback({
104104
config,
105105
message: 'Creating .vsix package...',
106106
successMessage: 'Created .vsix package.',
@@ -116,7 +116,7 @@ async function createPackage(config: PublishOptions) {
116116

117117
async function publishToVsce(vsix: string, config: PublishOptions) {
118118
const exec = async (args: string[]) => {
119-
return await tryExec({
119+
return await executeWithFeedback({
120120
config,
121121
message: 'Publishing to vsce...',
122122
successMessage: 'Published to vsce.',
@@ -140,8 +140,7 @@ async function publishToVsce(vsix: string, config: PublishOptions) {
140140

141141
async function publishToOvsx(vsix: string, config: PublishOptions) {
142142
const args = normalizeArgs(['ovsx', 'publish', vsix], config)
143-
144-
return await tryExec({
143+
return await executeWithFeedback({
145144
config,
146145
message: 'Publishing to ovsx...',
147146
successMessage: 'Published to ovsx.',
@@ -157,7 +156,7 @@ async function publishToOvsx(vsix: string, config: PublishOptions) {
157156

158157
async function publishToGit(vsix: string, config: PublishOptions) {
159158
const args = ['release', 'upload', config.tag, vsix, '--repo', config.repo, '--clobber']
160-
return await tryExec({
159+
return await executeWithFeedback({
161160
config,
162161
message: 'Uploading .vsix to release page...',
163162
successMessage: 'Uploaded .vsix to release page.',
@@ -178,7 +177,7 @@ function normalizeArgs(args: string[], options: PublishOptions) {
178177
return args
179178
}
180179

181-
async function tryExec(options: {
180+
async function executeWithFeedback(options: {
182181
config: PublishOptions
183182
message: string
184183
successMessage: string

0 commit comments

Comments
 (0)