Improve comment blocks in version.yml

Removed the unnecessary "optional" commented code blocks from
version.yml, and replaced them with a small explainer annotation at the
top.

Author: TheMrCam

.github/workflows/version.yml

@@ -1,3 +1,15 @@
+# Create and push the commit and tag created from npm version <version>
+# 
+# From the Actions page on GitHub, users (with write permissions) can select
+# the desired release <version> and this action will handle running npm version
+# and pushing the tag to the repository.
+#
+# Due to the VERSION_TOKEN, the tag push will trigger release.yml, which handles
+# releasing to npm and GitHub releases.
+#
+# With pre* versions (prerelease, prepatch, etc.), the tag will be created with
+# --preid beta. Currently, they are released normally, to --tag latest on npm.
+
 name: Push new version
 
 on:
@@ -16,41 +28,12 @@ on:
         - prepatch
         - preminor
         - premajor
-      # Uncomment the following for text input preId
-      # preId:
-      #   description: 'Prerelease identifier (required with pre*)'
-      #   required: false
-      #   type: string
-      # Uncomment the following for selection preId
-      # preId:
-      #   description: 'Prerelease identifier (used with pre*)'
-      #   required: true
-      #   default: 'beta'
-      #   type: choice
-      #   options:
-      #   - alpha
-      #   - beta
 
 jobs:
-  # Uncomment the following step if using text input preId
-  # validate:
-    # name: Validate workflow inputs
-    # runs-on: ubuntu-latest
-
-    # steps:
-    # - name: Invalid prerelease identifier
-      # if: ${{ startsWith(github.event.inputs.version, 'pre') && !github.event.inputs.preId }}
-      # run: |
-        # echo "Error: 'preId' input is required with 'pre-*' version."
-        # exit 1
-
   version:
     name: Push ${{ inputs.version }} tag
     runs-on: ubuntu-latest
 
-    # Uncomment the following line if using the validate step above
-    # needs: [validate]
-
     steps:
     - name: Checkout branch
       uses: actions/checkout@v4
@@ -67,10 +50,7 @@ jobs:
       run: |
         git config --global user.name "${{ github.actor }}"
         git config --global user.email "${{ github.actor }}@users.noreply.github.com"
-    - name: NPM version
-      # Uncomment the following line if using preId input
-      # run: echo "version=$(npm version ${{ inputs.version }}${{ startsWith(inputs.version, 'pre') && format(' --preid {0}', inputs.preId) || '' }})" >> "$GITHUB_ENV"
-      # Uncomment the following line for hardcoded 'beta' preId
-      run: echo "version=$(npm version ${{ inputs.version }})${{ startsWith(inputs.version, 'pre') && '--preid beta' || ''}}" >> "$GITHUB_ENV"
-    - name: Git push
+    - name: npm version ${{ inputs.version }}
+      run: echo "version=$(npm version ${{ inputs.version }}${{ startsWith(inputs.version, 'pre') && '--preid beta' || '' }})" >> "$GITHUB_ENV"
+    - name: git push
       run: git push && git push origin ${{ env.version }}