feat: publish releases to WinGet and Scoop

.github/workflows/release.yml

@@ -197,6 +197,28 @@ jobs:
             exit 1
           fi
 
+      - name: Embed Windows PE metadata
+        if: matrix.goos == 'windows'
+        env:
+          VERSION: ${{ needs.determine-version.outputs.version }}
+        run: |
+          set -euo pipefail
+          go install github.com/tc-hib/go-winres@v0.3.3
+          VERSION_NO_V="${VERSION#v}"
+          # PE version must be X.Y.Z.W (four numeric components)
+          PE_VERSION="${VERSION_NO_V}.0"
+          YEAR="$(date -u +%Y)"
+          go-winres simply \
+            --arch amd64,arm64 \
+            --out cmd/bb/rsrc \
+            --manifest cli \
+            --file-description "Bitbucket Server CLI" \
+            --product-name "Bitbucket Server CLI" \
+            --file-version "${PE_VERSION}" \
+            --product-version "${PE_VERSION}" \
+            --copyright "Copyright ${YEAR} Michael de Vries" \
+            --original-filename "bb.exe"
+
       - name: Build and package artifact
         env:
           VERSION: ${{ needs.determine-version.outputs.version }}
@@ -212,7 +234,7 @@ jobs:
           BINARY_NAME="bb${BINARY_EXT}"
           ARCHIVE_BASENAME="bb_${VERSION_NO_V}_${GOOS}_${GOARCH}"
 
-          CGO_ENABLED=0 GOOS="$GOOS" GOARCH="$GOARCH" go build -trimpath -ldflags "-X main.Version=${VERSION}" -o "$BINARY_NAME" ./cmd/bb
+          CGO_ENABLED=0 GOOS="$GOOS" GOARCH="$GOARCH" go build -trimpath -ldflags "-s -w -buildid= -X main.Version=${VERSION}" -o "$BINARY_NAME" ./cmd/bb
 
           if [[ "$ARCHIVE" == "zip" ]]; then
             ARCHIVE_NAME="${ARCHIVE_BASENAME}.zip"
@@ -487,3 +509,105 @@ jobs:
           git config user.name "github-actions[bot]"
           git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
           task docs:deploy-version VERSION="$VERSION"
+
+  winget-release:
+    name: Publish to WinGet
+    needs:
+      - determine-version
+      - release
+    if: ${{ needs.determine-version.outputs.should_release == 'true' }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Publish to WinGet
+        uses: vedantmgoyal9/winget-releaser@v2
+        with:
+          identifier: vriesdemichael.bb
+          token: ${{ secrets.WINGET_TOKEN }}
+
+  scoop-release:
+    name: Publish to Scoop
+    needs:
+      - determine-version
+      - release
+    if: ${{ needs.determine-version.outputs.should_release == 'true' }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    env:
+      VERSION: ${{ needs.determine-version.outputs.version }}
+    steps:
+      - name: Download checksums from release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          set -euo pipefail
+          gh release download "$VERSION" \
+            --repo "$GITHUB_REPOSITORY" \
+            --pattern "sha256sums.txt" \
+            --output sha256sums.txt
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Update Scoop bucket manifest
+        env:
+          SCOOP_BUCKET_TOKEN: ${{ secrets.SCOOP_BUCKET_TOKEN }}
+        run: |
+          set -euo pipefail
+          export VERSION_NO_V="${VERSION#v}"
+          export HASH_AMD64
+          HASH_AMD64=$(grep "bb_${VERSION_NO_V}_windows_amd64.zip" sha256sums.txt | awk '{print $1}')
+          export HASH_ARM64
+          HASH_ARM64=$(grep "bb_${VERSION_NO_V}_windows_arm64.zip" sha256sums.txt | awk '{print $1}')
+          export BASE_URL="https://github.com/${GITHUB_REPOSITORY}/releases/download/${VERSION}"
+
+          git clone https://github.com/vriesdemichael/scoop.git scoop-bucket
+          cd scoop-bucket
+          git config credential.helper \
+            '!f() { printf "username=x-access-token\npassword=%s\n" "${SCOOP_BUCKET_TOKEN}"; }; f'
+
+          python - <<'PY'
+          import json, os
+          version_no_v = os.environ["VERSION_NO_V"]
+          hash_amd64   = os.environ["HASH_AMD64"]
+          hash_arm64   = os.environ["HASH_ARM64"]
+          base_url     = os.environ["BASE_URL"]
+          repo_url     = f"https://github.com/{os.environ['GITHUB_REPOSITORY']}"
+          manifest = {
+              "version": version_no_v,
+              "description": "A CLI for Bitbucket Server / Bitbucket Data Center",
+              "homepage": repo_url,
+              "license": "Apache-2.0",
+              "architecture": {
+                  "64bit": {
+                      "url": f"{base_url}/bb_{version_no_v}_windows_amd64.zip",
+                      "hash": hash_amd64,
+                  },
+                  "arm64": {
+                      "url": f"{base_url}/bb_{version_no_v}_windows_arm64.zip",
+                      "hash": hash_arm64,
+                  },
+              },
+              "bin": "bb.exe",
+              "checkver": {"github": repo_url},
+              "autoupdate": {
+                  "architecture": {
+                      "64bit": {"url": f"{repo_url}/releases/download/v$version/bb_$version_windows_amd64.zip"},
+                      "arm64": {"url": f"{repo_url}/releases/download/v$version/bb_$version_windows_arm64.zip"},
+                  },
+              },
+          }
+          with open("bb.json", "w", encoding="utf-8") as f:
+              json.dump(manifest, f, indent=2)
+              f.write("\n")
+          PY
+
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git add bb.json
+          git diff --cached --quiet || git commit -m "Update bb to ${VERSION}"
+          git push

.gitignore

@@ -14,3 +14,5 @@ __pycache__/
 /docs/.venv/
 /.tmp/*
 !/.tmp/.gitkeep
+# Generated Windows PE resource files (created by go-winres during CI builds)
+cmd/bb/rsrc_windows_*.syso

LICENSE

@@ -0,0 +1,192 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submitted" means any form of electronic, verbal,
+      or written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of discussing and
+      improving the Work, but excluding communication that is conspicuously
+      marked or designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by the combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a cross-claim
+      or counterclaim in a lawsuit) alleging that the Work or any patent
+      claim embodied in the Work constitutes direct or contributory patent
+      infringement, then any patent licenses granted to You under this License
+      for that Work shall terminate as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, in
+          at least one of the following places: within a NOTICE text
+          file distributed as part of the Derivative Works; within
+          the Source form or documentation, if provided along with the
+          Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices
+          normally appear. The contents of the NOTICE file are for
+          informational purposes only and do not modify the License.
+          You may add Your own attribution notices within Derivative
+          Works that You distribute, alongside or in addition to the
+          NOTICE text from the Work, provided that such additional
+          attribution notices cannot be construed as modifying the
+          License.
+
+      You may add Your own license statement for Your modifications and
+      may provide additional grant of rights to use, reproduce, modify,
+      and distribute those modifications, or for such Derivative Works
+      as a whole, under the terms of this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or reproducing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or Liability. While redistributing the Work or
+      Derivative Works thereof, You may choose to offer, and charge a fee
+      for, acceptance of support, warranty, indemnity, or other liability
+      obligations and/or rights consistent with this License. However, in
+      accepting such obligations, You may offer such conditions only on
+      Your own behalf and on Your sole responsibility, not on behalf of
+      any other Contributor, and only if You agree to indemnify, defend,
+      and hold each Contributor harmless for any liability incurred by,
+      or claims asserted against, such Contributor by reason of your
+      accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the format in question. Please also make a
+      copy of the license document for recipients.
+
+         Copyright 2024 Michael de Vries
+
+         Licensed under the Apache License, Version 2.0 (the "License");
+         you may not use this file except in compliance with the License.
+         You may obtain a copy of the License at
+
+             http://www.apache.org/licenses/LICENSE-2.0
+
+         Unless required by applicable law or agreed to in writing, software
+         distributed under the License is distributed on an "AS IS" BASIS,
+         WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+         See the License for the specific language governing permissions and
+         limitations under the License.

README.md

@@ -28,6 +28,19 @@ repository cloning and browser navigation ergonomics tailored to Bitbucket-hoste
 
 ## Quick start
 
+Install on Windows via WinGet:
+
+```powershell
+winget install vriesdemichael.bb
+```
+
+Install on Windows via Scoop:
+
+```powershell
+scoop bucket add vriesdemichael https://github.com/vriesdemichael/scoop
+scoop install vriesdemichael/bb
+```
+
 Install from Releases (Linux amd64 example):
 
 ```bash

docs/site/installation-and-quickstart.md

@@ -1,5 +1,18 @@
 # Installation and Quickstart
 
+## Install on Windows via WinGet
+
+```powershell
+winget install vriesdemichael.bb
+```
+
+## Install on Windows via Scoop
+
+```powershell
+scoop bucket add vriesdemichael https://github.com/vriesdemichael/scoop
+scoop install vriesdemichael/bb
+```
+
 ## Install from release artifacts
 
 1. Select a release version (example: `v0.1.0`).