chore: upload the package as artifact on pr

laggage · laggage · commit 0d048f1b242b · 2023-03-16T16:10:21.000+08:00
diff --git a/.github/workflows/build-check.yml b/.github/workflows/build-check.yml
@@ -20,11 +20,26 @@ jobs:
               with:
                   node-version: ${{ matrix.node-version }}
                   cache: 'npm'
-            - name: 'Install Dependencies'
+            - name: 'Installing Dependencies'
               run: npm ci
-            - name: 'Lint'
+            - name: 'Linting'
               run: npm run lint
-            - name: 'Unit Test'
+            - name: 'Testing(Unit)'
               run: npm run test:unit
-            - name: 'Build'
-              run: npm run vscode:prepublish
+            - name: 'Building'
+              run: ./build.sh "${{ secrets.OAUTHCLIENTID }}" "${{ secrets.OAUTHCLIENTSECRET }}"
+            - name: 'Preparing VSCE'
+              run: npm i -g vsce
+            - name: 'Versioning'
+              id: version
+              run: echo "VERSION=1.0.0-beta.$(date +%s)" >> $GITHUB_OUTPUT
+            - name: 'Packaging'
+              id: packaging
+              run: |
+                  vsce package --pre-release --no-update-package-json --no-git-tag-version ${{ steps.version.outputs.VERSION }} && \
+                  echo "PKG_NAME=vscode-cnb-${{ steps.version.outputs.VERSION }}.vsix" >> $GITHUB_OUTPUT
+            - name: Uploading the Package
+              uses: actions/upload-artifact@v3
+              with:
+                  name: ${{ steps.packaging.outputs.PKG_NAME }}
+                  path: ./${{ steps.packaging.outputs.PKG_NAME }}
diff --git a/.github/workflows/marketplace-publish.yml b/.github/workflows/marketplace-publish.yml
@@ -19,28 +19,21 @@ jobs:
             matrix:
                 node-version: [16.x]
                 # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
-
         steps:
             - uses: actions/checkout@v2
             - name: Use Node.js ${{ matrix.node-version }}
               uses: actions/setup-node@v2
               with:
                   node-version: ${{ matrix.node-version }}
                   cache: 'npm'
-            - run: echo "VERSION=${GITHUB_REF#refs/*/}"
-            # add tag value to env
-            - run: echo "VERSION=${GITHUB_REF#refs/*/}" | sed 's/v//' >> $GITHUB_ENV
-            - run: echo "version:\ ${{ env.VERSION }}"
-            # globally install vsce
-            - run: npm i -g vsce
-            # replace client_id
-            - run: sed -i "s/clientId:\ 'vscode-cnb'/clientId:\ '${{ secrets.OAUTHCLIENTID }}'/" src/models/config.ts
-            # replace client_secret
-            - run: sed -i "s/clientSecret:\ ''/clientSecret:\ '${{ secrets.OAUTHCLIENTSECRET }}'/" src/models/config.ts
-            - run: echo "src/models/config.ts\n" && cat src/models/config.ts
-            # use env.VERSION to replace version property in package.json
-            - run: sed -i 's/\"version\":\ \"[0-9]\.[0-9]\.[0-9]\"/\"version\":\ \"${{ env.VERSION }}\"/' package.json
-            - run: echo "package.json\n" && cat package.json
-            - run: npm ci
-            # publish to vscode extension marketplace
-            - run: vsce publish -p ${{ secrets.VSCETOKEN }}
+            - name: 'Versioning'
+              id: version
+              run: echo "VERSION=${{ github.ref_name }}" | sed 's/v//' >> $GITHUB_OUTPUT
+            - name: 'Installing Dependencies'
+              run: npm ci
+            - name: 'Building'
+              run: ./build.sh "${{ secrets.OAUTHCLIENTID }}" "${{ secrets.OAUTHCLIENTSECRET }}"
+            - name: 'Preparing VSCE'
+              run: npm i -g vsce
+            - name: 'Publishing'
+              run: vsce publish --no-git-tag-version --no-update-package-json -p ${{ secrets.VSCETOKEN }} ${{ steps.version.outputs.VERSION }}
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,4 @@ node_modules
 *.vsix
 .DS_Store
 .idea
+.vscode/api-key.txt
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -1,5 +1,5 @@
 {
     // See http://go.microsoft.com/fwlink/?LinkId=827846
     // for the documentation about the extensions.json format
-    "recommendations": ["dbaeumer.vscode-eslint", "amodio.tsl-problem-matcher"]
+    "recommendations": ["dbaeumer.vscode-eslint", "amodio.tsl-problem-matcher", "rioj7.command-variable"]
 }
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -13,14 +13,19 @@
     "editor.formatOnSave": true,
     "cSpell.words": [
         "ASPNETCORE",
+        "CLIENTID",
+        "CLIENTSECRET",
         "fluentui",
         "iconfont",
         "ings",
         "nbsp",
+        "OAUTHCLIENTID",
+        "OAUTHCLIENTSECRET",
         "randomstring",
         "singleline",
         "tailwindcss",
-        "untildify"
+        "untildify",
+        "vsix"
     ],
     "json.format.enable": false,
     "eslint.alwaysShowStatus": true,
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -7,10 +7,31 @@
             "NODE_ENV": "Development"
         }
     },
+    "inputs": [
+        {
+            "id": "ClientId",
+            "type": "command",
+            "command": "extension.commandvariable.file.content",
+            "args": {
+                "fileName": "${workspaceFolder}/.vscode/api-key.txt",
+                "key": "CLIENTID"
+            }
+        },
+        {
+            "id": "ClientSecret",
+            "type": "command",
+            "command": "extension.commandvariable.file.content",
+            "args": {
+                "fileName": "${workspaceFolder}/.vscode/api-key.txt",
+                "key": "CLIENTSECRET"
+            }
+        }
+    ],
     "tasks": [
         {
-            "type": "npm",
-            "script": "watch",
+            "type": "shell",
+            "label": "npm: watch",
+            "command": "npm run watch -- --env CLIENTID=${input:ClientId} --env CLIENTSECRET=${input:ClientSecret}",
             "problemMatcher": ["$ts-webpack-watch", "$tslint-webpack-watch"],
             "isBackground": true,
             "presentation": {
@@ -19,7 +40,8 @@
             },
             "group": {
                 "kind": "build"
-            }
+            },
+            "runOptions": { "reevaluateOnRerun": false }
         },
         {
             "type": "npm",
diff --git a/build.sh b/build.sh
@@ -0,0 +1,7 @@
+#!/bin/bash
+
+set -e
+
+npm run package -- --env CLIENTID="${1?"Please provide the CLIENTID"}" --env CLIENTSECRET="${2?"Please provide the CLIENTSECRET"}"
+npm run ui:package
+
diff --git a/package.json b/package.json
@@ -1015,12 +1015,11 @@
         ]
     },
     "scripts": {
-        "vscode:prepublish": "npm run package",
         "compile": "webpack && npm run ui:compile",
         "ui:compile": "webpack -c ./ui/webpack.config.mjs",
         "watch": "webpack --watch",
         "ui:watch": "webpack watch -c ./ui/webpack.config.mjs",
-        "package": "webpack --mode production --devtool hidden-source-map && npm run ui:package",
+        "package": "webpack --mode production --devtool hidden-source-map",
         "ui:package": "webpack --mode production --devtool hidden-source-map -c ./ui/webpack.config.mjs",
         "compile-tests": "tsc -p ./tsconfig.integration.json --outDir out",
         "test:integration:watch": "npm run compile-tests -- --watch",
diff --git a/src/models/config.ts b/src/models/config.ts
@@ -19,14 +19,17 @@ export interface IExtensionConfig {
 
 export const isDev = () => process.env.NODE_ENV === 'Development';
 
+declare const CNBLOGS_CLIENTID: string;
+declare const CNBLOGS_CLIENTSECRET: string;
+
 export const defaultConfig: IExtensionConfig = {
     oauth: {
         authority: 'https://oauth.cnblogs.com',
         tokenEndpoint: '/connect/token',
         authorizeEndpoint: '/connect/authorize',
         userInfoEndpoint: '/connect/userinfo',
-        clientId: 'vscode-cnb',
-        clientSecret: '',
+        clientId: CNBLOGS_CLIENTID,
+        clientSecret: CNBLOGS_CLIENTSECRET,
         responseType: 'code',
         scope: 'openid profile CnBlogsApi CnblogsAdminApi',
         revocationEndpoint: '/connection/revocation',
diff --git a/webpack.config.mjs b/webpack.config.mjs
@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
 /* eslint-disable @typescript-eslint/naming-convention */
 //@ts-check
 
@@ -7,65 +8,73 @@ import path from 'path';
 import CopyWebpackPlugin from 'copy-webpack-plugin';
 import { TsconfigPathsPlugin } from 'tsconfig-paths-webpack-plugin';
 import { fileURLToPath } from 'url';
+import webpack from 'webpack';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 
 //@ts-check
 /** @typedef {import('webpack').Configuration} WebpackConfig **/
 
-/** @type WebpackConfig */
-const extensionConfig = {
-    target: 'node', // vscode extensions run in a Node.js-context 📖 -> https://webpack.js.org/configuration/node/
-    mode: 'none', // this leaves the source code as close as possible to the original (when packaging we set this to 'production')
+export default env => {
+    /** @type WebpackConfig */
+    const extensionConfig = {
+        target: 'node', // vscode extensions run in a Node.js-context 📖 -> https://webpack.js.org/configuration/node/
+        mode: 'none', // this leaves the source code as close as possible to the original (when packaging we set this to 'production')
 
-    entry: { extension: './src/extension.ts', markdown: './src/markdown/markdown.entry.ts' }, // the entry point of this extension, 📖 -> https://webpack.js.org/configuration/entry-context/
-    output: {
-        // the bundle is stored in the 'dist' folder (check package.json), 📖 -> https://webpack.js.org/configuration/output/
-        path: path.resolve(__dirname, 'dist'),
-        filename: '[name].js',
-        libraryTarget: 'commonjs2',
-    },
-    externals: {
-        vscode: 'commonjs vscode', // the vscode-module is created on-the-fly and must be excluded. Add other modules that cannot be webpack'ed, 📖 -> https://webpack.js.org/configuration/externals/
-        // modules added here also need to be added in the .vscodeignore file
-    },
-    resolve: {
-        // support reading TypeScript and JavaScript files, 📖 -> https://github.com/TypeStrong/ts-loader
-        extensions: ['.ts', '.js'],
-        plugins: [new TsconfigPathsPlugin({ configFile: './tsconfig.json' })],
-    },
-    module: {
-        rules: [
-            {
-                test: /\.ts$/,
-                exclude: /node_modules\/(?!lodash-es.*)/,
-                use: [
+        entry: { extension: './src/extension.ts', markdown: './src/markdown/markdown.entry.ts' }, // the entry point of this extension, 📖 -> https://webpack.js.org/configuration/entry-context/
+        output: {
+            // the bundle is stored in the 'dist' folder (check package.json), 📖 -> https://webpack.js.org/configuration/output/
+            path: path.resolve(__dirname, 'dist'),
+            filename: '[name].js',
+            libraryTarget: 'commonjs2',
+        },
+        externals: {
+            vscode: 'commonjs vscode', // the vscode-module is created on-the-fly and must be excluded. Add other modules that cannot be webpack'ed, 📖 -> https://webpack.js.org/configuration/externals/
+            // modules added here also need to be added in the .vscodeignore file
+        },
+        resolve: {
+            // support reading TypeScript and JavaScript files, 📖 -> https://github.com/TypeStrong/ts-loader
+            extensions: ['.ts', '.js'],
+            plugins: [new TsconfigPathsPlugin({ configFile: './tsconfig.json' })],
+        },
+        module: {
+            rules: [
+                {
+                    test: /\.ts$/,
+                    exclude: /node_modules\/(?!lodash-es.*)/,
+                    use: [
+                        {
+                            loader: 'ts-loader',
+                        },
+                    ],
+                },
+            ],
+        },
+        devtool: 'nosources-source-map',
+        infrastructureLogging: {
+            level: 'log', // enables logging required for problem matchers
+        },
+        plugins: [
+            new CopyWebpackPlugin({
+                patterns: [
                     {
-                        loader: 'ts-loader',
+                        //Note:- No wildcard is specified hence will copy all files and folders
+                        from: 'src/assets', //Will resolve to RepoDir/src/assets
+                        to: 'assets', //Copies all files from above dest to dist/assets
+                    },
+                    {
+                        from: 'node_modules/@cnblogs/code-highlight-adapter/index.min.css',
+                        to: 'assets/styles/highlight-code-lines.css',
                     },
                 ],
-            },
+            }),
+            new webpack.DefinePlugin({
+                CNBLOGS_CLIENTID: JSON.stringify(env.CLIENTID || 'vscode-cnb'),
+                CNBLOGS_CLIENTSECRET: JSON.stringify(env.CLIENTSECRET || ''),
+            }),
         ],
-    },
-    devtool: 'nosources-source-map',
-    infrastructureLogging: {
-        level: 'log', // enables logging required for problem matchers
-    },
-    plugins: [
-        new CopyWebpackPlugin({
-            patterns: [
-                {
-                    //Note:- No wildcard is specified hence will copy all files and folders
-                    from: 'src/assets', //Will resolve to RepoDir/src/assets
-                    to: 'assets', //Copies all files from above dest to dist/assets
-                },
-                {
-                    from: 'node_modules/@cnblogs/code-highlight-adapter/index.min.css',
-                    to: 'assets/styles/highlight-code-lines.css',
-                },
-            ],
-        }),
-    ],
+    };
+
+    return extensionConfig;
 };
-export default [extensionConfig];

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`	`2`	`// See http://go.microsoft.com/fwlink/?LinkId=827846`
`3`	`3`	`// for the documentation about the extensions.json format`
`4`		`- "recommendations": ["dbaeumer.vscode-eslint", "amodio.tsl-problem-matcher"]`
	`4`	`+ "recommendations": ["dbaeumer.vscode-eslint", "amodio.tsl-problem-matcher", "rioj7.command-variable"]`
`5`	`5`	`}`