Refine releasing workflow (#685)

Author: ybiquitous

.github/workflows/releasing.yml

@@ -2,11 +2,6 @@ name: Releasing
 
 on:
   workflow_dispatch:
-    inputs:
-      version:
-        description: 'Version to release, e.g., "1.0.0"'
-        required: true
-        type: string
 
 jobs:
   release:
@@ -52,23 +47,26 @@ jobs:
         run: xvfb-run -a npm run test:e2e
 
       - name: Publish
-        run: |
-          # Prepare for a new commit via the release script.
-          git config user.name "${GITHUB_ACTOR}"
-          git config user.email "${GITHUB_ACTOR_ID}+${GITHUB_ACTOR}@users.noreply.github.com"
-
-          npm run release -- "${NEW_VERSION}"
-
-          git push origin --follow-tags
+        run: npm run release
         env:
           VSCE_PAT: ${{ secrets.VSCE_PAT }}
-          NEW_VERSION: ${{ github.event.inputs.version }}
 
       - name: Create GitHub release
+        shell: bash
         run: |
-          latest_tag=$(git describe --tags --abbrev=0)
-          gh release create "${latest_tag}" --generate-notes
+          # Prepare for a new tag.
+          git config user.name "${GITHUB_ACTOR}"
+          git config user.email "${GITHUB_ACTOR_ID}+${GITHUB_ACTOR}@users.noreply.github.com"
+
+          # Create and push a Git tag.
+          new_version=$(npm pkg get version | tr -d '"')
+          new_tag="v${new_version}"
+          git tag --annotate "${new_version}" -m "${new_version}" "${new_tag}"
+          git push origin "${new_tag}"
+
+          # Create a GitHub release.
+          gh release create "${new_tag}" --generate-notes
           release_url=$(gh release view "${latest_tag}" --json url --jq '.url')
-          echo "::notice::Release created: ${release_url}"
+          echo "::notice::${release_url} was created successfully. Adjust the release notes from the changelog to keep the consistency with other releases."
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

RELEASE.md

@@ -5,8 +5,14 @@ This is a guide for maintainers.
 To release a new version, take the following steps:
 
 1. Check if the latest CI is successful on [GitHub Actions](https://github.com/stylelint/vscode-stylelint/actions/workflows/testing.yml).
-2. Create a pull request to prepare the release, determining a new version and updating the changelog. E.g., "Prepare 1.0.0"
+2. Create a pull request to prepare the release.
+   1. Determine a new version, such as "1.0.0".
+   2. Update `CHANGELOG.md` to add the new version and notable changes since the last version.
+   3. Run `NEW_VERSION=<new_version> npm run prepare-release` to commit the changes, including `package.json`.
+   4. Push a new commit.
+   5. Create a pull request.
 3. Merge the pull request if it's approved.
 4. Wait until the latest CI is completed.
-5. Run the releasing workflow with a new version input on [GitHub Actions](https://github.com/stylelint/vscode-stylelint/actions/workflows/releasing.yml) if there are no problems on the CI.
+5. Run the releasing workflow on [GitHub Actions](https://github.com/stylelint/vscode-stylelint/actions/workflows/releasing.yml) if the CI succeeds.
 6. Confirm that the new version is available on [VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint).
+7. Adjust the release notes on [GitHub Releases](https://github.com/stylelint/vscode-stylelint/releases).

package.json

@@ -269,7 +269,8 @@
     "test:node-versions": "node scripts/test-node-versions.js",
     "jest": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
     "vscode:prepublish": "npm run build && npm run bundle-base -- --minify",
-    "release": "vsce publish"
+    "prepare-release": "npm version --no-git-tag-version \"${NEW_VERSION}\" && git commit --all --message \"Release ${NEW_VERSION}\"",
+    "release": "vsce publish --no-git-tag-version --no-update-package-json"
   },
   "prettier": "@stylelint/prettier-config",
   "volta": {