From 8fd7af98d9718fcfbf60f865bccdc540ba43d934 Mon Sep 17 00:00:00 2001 From: Joel Challis Date: Tue, 21 Apr 2026 00:21:40 +0100 Subject: [PATCH] Remove qmk_fpm references (#233) --- .github/workflows/python-publish.yml | 4 ---- README.md | 25 ++++++++++-------------- requirements-dev.txt | 1 - trigger_packages | 29 ---------------------------- 4 files changed, 10 insertions(+), 49 deletions(-) delete mode 100755 trigger_packages diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml index cc6185d..d9820ed 100644 --- a/.github/workflows/python-publish.yml +++ b/.github/workflows/python-publish.yml @@ -88,7 +88,3 @@ jobs: ghcr.io/qmk/qmk_cli:${{ env.NEW_CLI_VERSION }} qmkfm/qmk_cli:${{ env.NEW_CLI_VERSION }} - - name: Trigger OS package builds - run: ./trigger_packages - env: - QMK_BOT_TOKEN: ${{ secrets.QMK_BOT_TOKEN }} diff --git a/README.md b/README.md index 0937ea7..8424d7f 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ A program to help users work with [QMK Firmware](https://qmk.fm/). -# Features +## Features * Interact with your qmk_firmware tree from any location * Use `qmk clone` to pull down anyone's `qmk_firmware` fork @@ -17,30 +17,25 @@ A program to help users work with [QMK Firmware](https://qmk.fm/). * `qmk lint` * ...and many more! -# Packages +## Quickstart + +Follow our [documentation to get started](https://docs.qmk.fm/newbs_getting_started). + +## Packages We provide "install and go" packages for many Operating Systems. -## Linux - -Packages for several distributions available here: https://github.com/qmk/qmk_fpm - -## macOS +### macOS Using [Homebrew](https://brew.sh): brew install qmk/qmk/qmk -## Windows +### Windows Download our custom MSYS2 installer here: https://msys.qmk.fm/ -# Quickstart - -* `python3 -m pip install qmk` -* `qmk setup` - -# Building +## Building We follow PEP517, you can install using [build](https://pypi.org/project/build/): @@ -54,6 +49,6 @@ Build: You can read more about working with PEP517 packages in the [Python Packaging User Guide](https://packaging.python.org/guides/distributing-packages-using-setuptools/#packaging-your-project). -# Documentation +## Documentation Full documentation: diff --git a/requirements-dev.txt b/requirements-dev.txt index ecfedc3..407d6e6 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -1,4 +1,3 @@ build bumpversion -requests twine diff --git a/trigger_packages b/trigger_packages deleted file mode 100755 index 8311da5..0000000 --- a/trigger_packages +++ /dev/null @@ -1,29 +0,0 @@ -#!/usr/bin/env python3 -"""Trigger workflows that build QMK packages. -""" -from os import environ -from pathlib import Path - -import requests - -# Pull in environment vars -gh_user = environ.get('GH_USERNAME', 'qmk-bot') -gh_pat = environ.get('QMK_BOT_TOKEN', '') -gh_repo_owner = environ.get('REPO_OWNER', 'qmk') -gh_repo_name = environ.get('REPO_NAME', 'qmk_fpm') -gh_ref = environ.get('BRANCH_NAME', 'main') -gh_workflow_ids = environ.get('WORKFLOW_IDS', 'all-trigger.yml').split(',') -gh_api_url = environ.get('GITHUB_API_URL', 'https://api.github.com') -gh_workflow_args = {'ref': gh_ref} -gh_workflow_headers = {'Accept': 'application/vnd.github.v3+json'} - -for gh_workflow_id in gh_workflow_ids: - gh_workflow_endpoint = f'{gh_api_url}/repos/{gh_repo_owner}/{gh_repo_name}/actions/workflows/{gh_workflow_id}/dispatches' - print(f'Triggering {gh_workflow_id} workflow at: {gh_workflow_endpoint}') - workflow_dispatch = requests.post(gh_workflow_endpoint, headers=gh_workflow_headers, json=gh_workflow_args, auth=(gh_user, gh_pat)) - if workflow_dispatch.status_code != 204: - print(f'Error from GitHub API, status_code {workflow_dispatch.status_code}!') - print(workflow_dispatch.text) - exit(1) - -exit(0)