From 74c71bbef56029f2c2a31c55a7cdef49909d77de Mon Sep 17 00:00:00 2001 From: Joel Spadin Date: Sun, 18 Aug 2024 12:48:18 -0500 Subject: [PATCH] Change owner to zmkfirmware and add release workflow --- .github/workflows/release.yml | 86 +++++++++++++++++++++++++++++++++++ README.md | 2 +- pyproject.toml | 4 +- 3 files changed, 89 insertions(+), 3 deletions(-) create mode 100644 .github/workflows/release.yml diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..85adffb --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,86 @@ +name: Release + +on: + push: + tags: ["*"] + +jobs: + build: + name: Build distribution + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + with: + python-version: ">=3.10" + - name: Install pypa/build + run: python3 -m pip install build --user + - name: Build wheel and source tarball + run: python3 -m build + - name: Store distribution packages + uses: actions/upload-artifact@v3 + with: + name: python-package-distributions + path: dist/ + + publish-to-pypi: + name: Publish Python distribution to PyPI + needs: + - build + runs-on: ubuntu-latest + environment: + name: pypi + url: https://pypi.org/p/zmk + permissions: + id-token: write + + steps: + - name: Download artifacts + uses: actions/download-artifact@v3 + with: + name: python-package-distributions + path: dist/ + - name: Publish to PyPI + uses: pypa/gh-action-pypi-publish@release/v1 + + github-release: + name: GitHub release + needs: + - publish-to-pypi + runs-on: ubuntu-latest + + permissions: + contents: write + id-token: write + + steps: + - name: Download artifacts + uses: actions/download-artifact@v3 + with: + name: python-package-distributions + path: dist/ + - name: Sign artifacts + uses: sigstore/gh-action-sigstore-python@v3.0.0 + with: + inputs: >- + ./dist/*.tar.gz + ./dist/*.whl + - name: Create GitHub release + env: + GITHUB_TOKEN: ${{ github.token }} + run: >- + gh release create + '${{ github.ref_name }}' + --repo '${{ github.repository }}' + --notes "" + - name: Upload artifact signatures to GitHub release + env: + GITHUB_TOKEN: ${{ github.token }} + # Upload to GitHub Release using the `gh` CLI. + # `dist/` contains the built packages, and the + # sigstore-produced signatures and certificates. + run: >- + gh release upload + '${{ github.ref_name }}' dist/** + --repo '${{ github.repository }}' diff --git a/README.md b/README.md index 8eff471..cb8dc63 100644 --- a/README.md +++ b/README.md @@ -86,7 +86,7 @@ pipx ensurepath Next, run the following commands: ```sh -pipx install git+https://github.com/joelspadin/zmk-cli.git +pipx install zmk zmk --help ``` diff --git a/pyproject.toml b/pyproject.toml index 5cd3395..5c5f34a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -28,8 +28,8 @@ dynamic = ["version"] [project.urls] Documentation = "https://zmk.dev/docs" -"Source Code" = "https://github.com/joelspadin/zmk-cli/" -"Issue Tracker" = "https://github.com/joelspadin/zmk-cli/issues/" +"Source Code" = "https://github.com/zmkfirmware/zmk-cli/" +"Issue Tracker" = "https://github.com/zmkfirmware/zmk-cli/issues/" Chat = "https://zmk.dev/community/discord/invite" [project.scripts]