From 490f52d0be58ee74762b0aa3fc7e9cdc261b6e26 Mon Sep 17 00:00:00 2001 From: Hong Xu Date: Thu, 6 Feb 2025 09:33:29 -0800 Subject: [PATCH] Add notes on how to publish and remove the release workflow (#390) The release workflow doesn't appear to have been used and the secrets are missing. --- .github/workflows/release.yml | 127 ---------------------------------- DEVELOPER.md | 9 +++ 2 files changed, 9 insertions(+), 127 deletions(-) delete mode 100644 .github/workflows/release.yml create mode 100644 DEVELOPER.md diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index 56c26bc..0000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,127 +0,0 @@ -name: Publish - -on: - workflow_dispatch: - inputs: - releaseType: - description: "Release Type" - required: true - type: choice - default: "patch" - options: - - patch - - minor - - major - releaseChannel: - description: "Release Channel" - required: true - type: choice - default: stable - options: - - stable - - edge - publishMarketplace: - description: "Publish on Visual Studio Marketplace?" - required: true - type: choice - default: "yes" - options: - - "yes" - - "no" - publishOpenVSX: - description: "Publish on Open VSX Registry?" - required: true - type: choice - default: "yes" - options: - - "yes" - - "no" - -jobs: - release: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v4 - - name: Setup Node - uses: actions/setup-node@v4 - with: - node-version: lts/* - - name: Install - run: npm ci - - name: Create Changelog - run: | - git log $(git describe --tags --abbrev=0)..HEAD --oneline &> ${{ github.workspace }}-CHANGELOG.txt - cat ${{ github.workspace }}-CHANGELOG.txt - - name: Setup Git - run: | - git config --global user.name "christian-bromann" - git config --global user.email "git@bromann.dev" - - name: Get Current Version Number - run: | - CURRENT_VERSION=$(cat package.json | jq .version | cut -d'"' -f 2) - echo "CURRENT_VERSION=$CURRENT_VERSION" >> $GITHUB_ENV - - name: Compile New Version (Edge) - run: | - RELEASE_VERSION=$(npx semver $CURRENT_VERSION -i pre${{ github.event.inputs.releaseType }} --preid edge) - echo "RELEASE_VERSION=$RELEASE_VERSION" >> $GITHUB_ENV - echo "Bump to $RELEASE_VERSION" - if: ${{ github.event.inputs.releaseChannel == 'edge' && !contains(env.CURRENT_VERSION, 'edge') }} - - name: Compile New Version (Edge) - run: | - RELEASE_VERSION=$(npx semver $CURRENT_VERSION -i prerelease) - echo "RELEASE_VERSION=$RELEASE_VERSION" >> $GITHUB_ENV - echo "Bump to $RELEASE_VERSION" - if: ${{ github.event.inputs.releaseChannel == 'edge' && contains(env.CURRENT_VERSION, 'edge') }} - - name: Compile New Version (Stable) - run: | - RELEASE_VERSION=$(npx semver $CURRENT_VERSION -i github.event.inputs.releaseType) - echo "RELEASE_VERSION=$RELEASE_VERSION" >> $GITHUB_ENV - echo "Bump to $RELEASE_VERSION" - if: ${{ github.event.inputs.releaseChannel == 'stable' }} - - name: Version Package - run: | - npm version $RELEASE_VERSION - git tag -a $RELEASE_VERSION -m "$RELEASE_VERSION" - - name: Package Extension (Edge) - if: ${{ github.event.inputs.releaseChannel == 'edge' }} - run: | - node .github/scripts/updateEdgeVersion.js - yarn vsce package --pre-release --yarn --no-git-tag-version --no-update-package-json -o "./editorconfig-$RELEASE_VERSION.vsix" ${{ github.event.inputs.additionalFlags }} - - name: Package Extension (Stable) - run: yarn vsce package $RELEASE_VERSION --yarn --no-git-tag-version --no-update-package-json -o "./editorconfig-$RELEASE_VERSION.vsix" ${{ github.event.inputs.additionalFlags }} - if: ${{ github.event.inputs.releaseChannel == 'stable' }} - - name: Publish to Visual Studio Marketplace (Edge) - run: yarn vsce publish --packagePath "./editorconfig-$RELEASE_VERSION.vsix" --pre-release --yarn --no-git-tag-version --no-update-package-json -p ${{ secrets.VSC_MKTP_PAT }} ${{ github.event.inputs.additionalFlags }} - if: ${{ github.event.inputs.publishMarketplace == 'yes' && github.event.inputs.releaseChannel == 'edge' }} - - name: Publish to Visual Studio Marketplace (Stable) - run: yarn vsce publish --packagePath "./editorconfig-$RELEASE_VERSION.vsix" --yarn --no-git-tag-version --no-update-package-json -p ${{ secrets.VSC_MKTP_PAT }} ${{ github.event.inputs.additionalFlags }} - if: ${{ github.event.inputs.publishMarketplace == 'yes' && github.event.inputs.releaseChannel == 'stable' }} - - name: Publish to Open VSX Registry (Edge) - uses: HaaLeo/publish-vscode-extension@v1 - if: ${{ github.event.inputs.publishOpenVSX == 'yes' && github.event.inputs.releaseChannel == 'edge' }} - with: - preRelease: true - pat: ${{ secrets.OPEN_VSX_TOKEN }} - extensionFile: ./editorconfig-${{ env.RELEASE_VERSION }}.vsix - - name: Publish to Open VSX Registry (Stable) - uses: HaaLeo/publish-vscode-extension@v1 - if: ${{ github.event.inputs.publishOpenVSX == 'yes' && github.event.inputs.releaseChannel == 'stable' }} - with: - preRelease: false - pat: ${{ secrets.OPEN_VSX_TOKEN }} - extensionFile: ./editorconfig-${{ env.RELEASE_VERSION }}.vsix - - name: Push Tags - run: | - git log -1 --stat - git push origin main --tags - - run: | - export GIT_TAG=$(git describe --tags --abbrev=0) - echo "GIT_TAG=$GIT_TAG" >> $GITHUB_ENV - - name: GitHub Release - uses: ncipollo/release-action@v1 - with: - artifacts: "./editorconfig-*" - bodyFile: ${{ github.workspace }}-CHANGELOG.txt - tag: ${{ env.GIT_TAG }} - prerelease: ${{ github.event.inputs.releaseChannel == 'edge' }} diff --git a/DEVELOPER.md b/DEVELOPER.md new file mode 100644 index 0000000..15c669a --- /dev/null +++ b/DEVELOPER.md @@ -0,0 +1,9 @@ +# Notes for Developers + +## Publish + +To publish a newer version to the Market Place, follow the [VSCode official +instructions][]. Then, +[Open VSX should update automatically](https://github.com/EclipseFdn/open-vsx.org/wiki/Auto-Publishing-Extensions#how-to-auto-publish-an-extension). + +[VSCode official instructions]: https://code.visualstudio.com/api/working-with-extensions/publishing-extension