[miryoku-github] Delete .github/ and readme.md
Manna Harbour
3 years ago
parent
7f413e9f01
commit
aebc99a4e0
@ -1,41 +0,0 @@
|
|||||||
name: Bug report
|
|
||||||
description: Create a report to help us improve QMK Firmware.
|
|
||||||
title: "[Bug] "
|
|
||||||
labels: ["bug", "help wanted"]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
Provide a general summary of the bug in the title above.
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Describe the Bug
|
|
||||||
description: A clear and concise description of what the bug is.
|
|
||||||
- type: input
|
|
||||||
attributes:
|
|
||||||
label: Keyboard Used
|
|
||||||
description: The name of the keyboard from the `make` or `qmk compile`/`qmk flash` commands, eg. `planck/rev6`.
|
|
||||||
- type: input
|
|
||||||
attributes:
|
|
||||||
label: Link to product page (if applicable)
|
|
||||||
- type: input
|
|
||||||
attributes:
|
|
||||||
label: Operating System
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: qmk doctor Output
|
|
||||||
description: Output from running the `qmk doctor` command.
|
|
||||||
render: text
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: Is AutoHotKey / Karabiner installed
|
|
||||||
options:
|
|
||||||
- label: AutoHotKey (Windows)
|
|
||||||
- label: Karabiner (macOS)
|
|
||||||
- type: input
|
|
||||||
attributes:
|
|
||||||
label: Other keyboard-related software installed
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Additional Context
|
|
||||||
description: Add any other relevant information about the problem here.
|
|
||||||
@ -1,8 +0,0 @@
|
|||||||
blank_issues_enabled: false
|
|
||||||
contact_links:
|
|
||||||
- name: QMK Discord
|
|
||||||
url: https://discord.gg/Uq7gcHh
|
|
||||||
about: Ask questions, discuss issues and features. Chill.
|
|
||||||
- name: OLKB Subreddit
|
|
||||||
url: https://www.reddit.com/r/olkb
|
|
||||||
about: All things OLKB and QMK.
|
|
||||||
@ -1,24 +0,0 @@
|
|||||||
name: Feature request
|
|
||||||
description: Suggest a new feature or changes to existing features.
|
|
||||||
title: "[Feature Request] "
|
|
||||||
labels: ["enhancement", "help wanted"]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
Provide a general summary of the changes you want in the title above.
|
|
||||||
|
|
||||||
Please refrain from asking maintainers to add support for specific keyboards -- it is unlikely they will have hardware available, and will not be able to help.
|
|
||||||
Your best bet is to take the initiative, add support, then submit a PR yourself.
|
|
||||||
- type: checkboxes
|
|
||||||
attributes:
|
|
||||||
label: Feature Request Type
|
|
||||||
options:
|
|
||||||
- label: Core functionality
|
|
||||||
- label: Add-on hardware support (eg. audio, RGB, OLED screen, etc.)
|
|
||||||
- label: Alteration (enhancement/optimization) of existing feature(s)
|
|
||||||
- label: New behavior
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Description
|
|
||||||
description: A few sentences describing what it is that you'd like to see in QMK. Additional information (such as links to spec sheets, licensing info, other related issues or PRs, etc) would be helpful.
|
|
||||||
@ -1,19 +0,0 @@
|
|||||||
name: Other issues
|
|
||||||
description: Anything else that doesn't fall into the above categories.
|
|
||||||
labels: ["help wanted", "question"]
|
|
||||||
body:
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
Provide a general summary of the changes you want in the title above.
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
Please check [https://docs.qmk.fm/#/support](https://docs.qmk.fm/#/support) for additional resources first. If that doesn't answer your question, choose the bug report template instead, as that may be more appropriate.
|
|
||||||
|
|
||||||
Please refrain from asking maintainers to add support for specific keyboards -- it is unlikely they will have hardware available, and will not be able to help.
|
|
||||||
Your best bet is to take the initiative, add support, then submit a PR yourself.
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Issue Description
|
|
||||||
description: Describe your issue in as much detail as possible.
|
|
||||||
@ -1,11 +0,0 @@
|
|||||||
---
|
|
||||||
name: Blank issue
|
|
||||||
about: If you're 100% sure that you don't need one of the other issue templates, use
|
|
||||||
this one instead.
|
|
||||||
title: ''
|
|
||||||
labels: help wanted, question
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
@ -1,35 +0,0 @@
|
|||||||
<!--- Provide a general summary of your changes in the title above. -->
|
|
||||||
|
|
||||||
<!--- This template is entirely optional and can be removed, but is here to help both you and us. -->
|
|
||||||
<!--- Anything on lines wrapped in comments like these will not show up in the final text. -->
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
<!--- Describe your changes in detail here. -->
|
|
||||||
|
|
||||||
## Types of Changes
|
|
||||||
|
|
||||||
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply. -->
|
|
||||||
- [ ] Core
|
|
||||||
- [ ] Bugfix
|
|
||||||
- [ ] New feature
|
|
||||||
- [ ] Enhancement/optimization
|
|
||||||
- [ ] Keyboard (addition or update)
|
|
||||||
- [ ] Keymap/layout/userspace (addition or update)
|
|
||||||
- [ ] Documentation
|
|
||||||
|
|
||||||
## Issues Fixed or Closed by This PR
|
|
||||||
|
|
||||||
*
|
|
||||||
|
|
||||||
## Checklist
|
|
||||||
|
|
||||||
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
|
|
||||||
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
|
|
||||||
- [ ] My code follows the code style of this project: [**C**](https://docs.qmk.fm/#/coding_conventions_c), [**Python**](https://docs.qmk.fm/#/coding_conventions_python)
|
|
||||||
- [ ] I have read the [**PR Checklist** document](https://docs.qmk.fm/#/pr_checklist) and have made the appropriate changes.
|
|
||||||
- [ ] My change requires a change to the documentation.
|
|
||||||
- [ ] I have updated the documentation accordingly.
|
|
||||||
- [ ] I have read the [**CONTRIBUTING** document](https://docs.qmk.fm/#/contributing).
|
|
||||||
- [ ] I have added tests to cover my changes.
|
|
||||||
- [ ] I have tested the changes and verified that they work and don't break anything (as well as I can manage).
|
|
||||||
@ -1,9 +0,0 @@
|
|||||||
version: 2
|
|
||||||
updates:
|
|
||||||
- package-ecosystem: "github-actions"
|
|
||||||
directory: "/"
|
|
||||||
labels: CI
|
|
||||||
reviewers:
|
|
||||||
- "qmk/collaborators"
|
|
||||||
schedule:
|
|
||||||
interval: "daily"
|
|
||||||
@ -1,42 +0,0 @@
|
|||||||
core:
|
|
||||||
- quantum/**/*
|
|
||||||
- tmk_core/**/*
|
|
||||||
- drivers/**/*
|
|
||||||
- tests/**/*
|
|
||||||
- util/**/*
|
|
||||||
- platforms/**/*
|
|
||||||
- builddefs/**/*
|
|
||||||
- Makefile
|
|
||||||
- '*.mk'
|
|
||||||
dependencies:
|
|
||||||
- any:
|
|
||||||
- 'lib/**/*'
|
|
||||||
- '!lib/python/**/*'
|
|
||||||
keyboard:
|
|
||||||
- any:
|
|
||||||
- 'keyboards/**/*'
|
|
||||||
- '!keyboards/**/keymaps/**/*'
|
|
||||||
keymap:
|
|
||||||
- users/**/*
|
|
||||||
- layouts/**/*
|
|
||||||
- keyboards/**/keymaps/**/*
|
|
||||||
via:
|
|
||||||
- keyboards/**/keymaps/via/*
|
|
||||||
cli:
|
|
||||||
- requirements.txt
|
|
||||||
- lib/python/**/*
|
|
||||||
python:
|
|
||||||
- '**/*.py'
|
|
||||||
documentation:
|
|
||||||
- docs/**/*
|
|
||||||
translation:
|
|
||||||
- docs/fr-fr/**/*
|
|
||||||
- docs/es/**/*
|
|
||||||
- docs/ja/**/*
|
|
||||||
- docs/he-il/**/*
|
|
||||||
- docs/pt-br/**/*
|
|
||||||
- docs/zh-cn/**/*
|
|
||||||
- docs/de/**/*
|
|
||||||
- docs/ru-ru/**/*
|
|
||||||
CI:
|
|
||||||
- .github/**/*
|
|
||||||
@ -1,50 +0,0 @@
|
|||||||
name: Update API Data
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
- develop
|
|
||||||
paths:
|
|
||||||
- 'keyboards/**'
|
|
||||||
- 'layouts/community/**'
|
|
||||||
- 'lib/python/**'
|
|
||||||
- 'data/**'
|
|
||||||
- '.github/workflows/api.yml'
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
api_data:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
container: qmkfm/qmk_cli
|
|
||||||
|
|
||||||
# protect against those who work in their fork on 'important' branches
|
|
||||||
if: github.repository == 'qmk/qmk_firmware'
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
with:
|
|
||||||
fetch-depth: 1
|
|
||||||
persist-credentials: false
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: |
|
|
||||||
pip3 install -r requirements-dev.txt
|
|
||||||
|
|
||||||
- name: Generate API Data
|
|
||||||
run: |
|
|
||||||
qmk generate-api
|
|
||||||
|
|
||||||
- name: Upload API Data
|
|
||||||
uses: jakejarvis/s3-sync-action@master
|
|
||||||
with:
|
|
||||||
args: --acl public-read --follow-symlinks --delete
|
|
||||||
env:
|
|
||||||
AWS_S3_BUCKET: ${{ github.ref == 'refs/heads/develop' && secrets['API_SPACE_DEVELOP'] || secrets['API_SPACE_MASTER'] }}
|
|
||||||
AWS_ACCESS_KEY_ID: ${{ secrets.SPACES_ACCESS_KEY }}
|
|
||||||
AWS_SECRET_ACCESS_KEY: ${{ secrets.SPACES_SECRET_KEY }}
|
|
||||||
AWS_S3_ENDPOINT: https://nyc3.digitaloceanspaces.com
|
|
||||||
SOURCE_DIR: '.build/api_data'
|
|
||||||
@ -1,20 +0,0 @@
|
|||||||
name: Automatic Approve
|
|
||||||
|
|
||||||
permissions: {}
|
|
||||||
|
|
||||||
on:
|
|
||||||
schedule:
|
|
||||||
- cron: "*/5 * * * *"
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
automatic_approve:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
if: github.repository == 'qmk/qmk_firmware'
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: mheap/automatic-approve-action@v1
|
|
||||||
with:
|
|
||||||
token: ${{ secrets.QMK_BOT_TOKEN }}
|
|
||||||
workflows: "format.yml,lint.yml,unit_test.yml"
|
|
||||||
dangerous_files: "lib/python/,Makefile,paths.mk,builddefs/"
|
|
||||||
@ -1,37 +0,0 @@
|
|||||||
name: Essential files modified
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
paths:
|
|
||||||
- builddefs/**/*
|
|
||||||
- drivers/**/*
|
|
||||||
- platforms/**/*
|
|
||||||
- quantum/**/*
|
|
||||||
- tests/**/*
|
|
||||||
- tmk_core/**/*
|
|
||||||
- util/**/*
|
|
||||||
- Makefile
|
|
||||||
- '*.mk'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
tag:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
# protect against those who develop with their fork on master
|
|
||||||
if: github.repository == 'qmk/qmk_firmware'
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
|
|
||||||
- name: Bump version and push tag
|
|
||||||
uses: anothrNick/github-tag-action@1.62.0
|
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
DEFAULT_BUMP: 'patch'
|
|
||||||
@ -1,74 +0,0 @@
|
|||||||
name: CI Builds
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [master, develop]
|
|
||||||
workflow_dispatch:
|
|
||||||
inputs:
|
|
||||||
branch:
|
|
||||||
type: choice
|
|
||||||
description: 'Branch to build'
|
|
||||||
options: [master, develop]
|
|
||||||
|
|
||||||
concurrency: ci_build-${{ github.event.inputs.branch || github.ref_name }}
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
ci_builds:
|
|
||||||
if: github.repository == 'qmk/qmk_firmware'
|
|
||||||
name: "CI Build"
|
|
||||||
runs-on: self-hosted
|
|
||||||
timeout-minutes: 1380
|
|
||||||
|
|
||||||
strategy:
|
|
||||||
fail-fast: false
|
|
||||||
matrix:
|
|
||||||
keymap: [default, via]
|
|
||||||
|
|
||||||
container: qmkfm/qmk_cli
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Disable safe.directory check
|
|
||||||
run : git config --global --add safe.directory '*'
|
|
||||||
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
with:
|
|
||||||
submodules: recursive
|
|
||||||
ref: ${{ github.event.inputs.branch || github.ref }}
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: pip3 install -r requirements.txt
|
|
||||||
|
|
||||||
- name: Run `qmk mass-compile` (keymap ${{ matrix.keymap }})
|
|
||||||
run: |
|
|
||||||
export NCPUS=$(nproc 2>/dev/null || sysctl -n hw.ncpu 2>/dev/null || getconf _NPROCESSORS_ONLN 2>/dev/null)
|
|
||||||
qmk mass-compile -t -j $NCPUS -km ${{ matrix.keymap }} -e DUMP_CI_METADATA=yes || touch .failed
|
|
||||||
# Generate the step summary markdown
|
|
||||||
./util/ci/generate_failure_markdown.sh > $GITHUB_STEP_SUMMARY || true
|
|
||||||
# Truncate to a maximum of 1MB to deal with GitHub workflow limit
|
|
||||||
truncate --size='<960K' $GITHUB_STEP_SUMMARY || true
|
|
||||||
# Exit with failure if the compilation stage failed
|
|
||||||
[ ! -f .failed ] || exit 1
|
|
||||||
|
|
||||||
- name: 'Upload artifacts'
|
|
||||||
uses: actions/upload-artifact@v3
|
|
||||||
if: always()
|
|
||||||
with:
|
|
||||||
name: artifacts-${{ github.event.inputs.branch || github.ref_name }}-${{ matrix.keymap }}
|
|
||||||
if-no-files-found: ignore
|
|
||||||
path: |
|
|
||||||
*.bin
|
|
||||||
*.hex
|
|
||||||
*.uf2
|
|
||||||
.build/failed.*
|
|
||||||
|
|
||||||
- name: 'CI Discord Notification'
|
|
||||||
if: always()
|
|
||||||
working-directory: util/ci/
|
|
||||||
env:
|
|
||||||
DISCORD_WEBHOOK: ${{ secrets.CI_DISCORD_WEBHOOK }}
|
|
||||||
run: |
|
|
||||||
python3 -m pip install -r requirements.txt
|
|
||||||
python3 ./discord-results.py --branch ${{ github.event.inputs.branch || github.ref_name }} --keymap ${{ matrix.keymap }} --url ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
|
|
||||||
@ -1,34 +0,0 @@
|
|||||||
name: CLI CI
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
- develop
|
|
||||||
pull_request:
|
|
||||||
paths:
|
|
||||||
- 'lib/python/**'
|
|
||||||
- 'requirements.txt'
|
|
||||||
- '.github/workflows/cli.yml'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
test:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
container: qmkfm/qmk_cli
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Disable safe.directory check
|
|
||||||
run : git config --global --add safe.directory '*'
|
|
||||||
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
with:
|
|
||||||
submodules: recursive
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: pip3 install -r requirements-dev.txt
|
|
||||||
- name: Run tests
|
|
||||||
run: qmk pytest
|
|
||||||
@ -1,37 +0,0 @@
|
|||||||
name: Update develop after master merge
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
develop_update:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
if: github.repository == 'qmk/qmk_firmware'
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
with:
|
|
||||||
token: ${{ secrets.QMK_BOT_TOKEN }}
|
|
||||||
fetch-depth: 0
|
|
||||||
|
|
||||||
- name: Disable automatic eol conversion
|
|
||||||
run: |
|
|
||||||
echo "* -text" > .git/info/attributes
|
|
||||||
|
|
||||||
- name: Checkout develop
|
|
||||||
run: |
|
|
||||||
git fetch origin master develop
|
|
||||||
git checkout develop
|
|
||||||
|
|
||||||
- name: Update develop from master
|
|
||||||
run: |
|
|
||||||
git config --global user.name "QMK Bot"
|
|
||||||
git config --global user.email "hello@qmk.fm"
|
|
||||||
git merge origin/master
|
|
||||||
git push origin develop
|
|
||||||
@ -1,46 +0,0 @@
|
|||||||
name: Generate Docs
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
paths:
|
|
||||||
- 'tmk_core/**'
|
|
||||||
- 'quantum/**'
|
|
||||||
- 'platforms/**'
|
|
||||||
- 'docs/**'
|
|
||||||
- '.github/workflows/docs.yml'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
generate:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
container: qmkfm/qmk_cli
|
|
||||||
|
|
||||||
# protect against those who develop with their fork on master
|
|
||||||
if: github.repository == 'qmk/qmk_firmware'
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
with:
|
|
||||||
fetch-depth: 1
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: |
|
|
||||||
apt-get update && apt-get install -y rsync nodejs npm doxygen
|
|
||||||
npm install -g moxygen
|
|
||||||
|
|
||||||
- name: Build docs
|
|
||||||
run: |
|
|
||||||
qmk --verbose generate-docs
|
|
||||||
|
|
||||||
- name: Deploy
|
|
||||||
uses: JamesIves/github-pages-deploy-action@v4.4.1
|
|
||||||
with:
|
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
BASE_BRANCH: master
|
|
||||||
BRANCH: gh-pages
|
|
||||||
FOLDER: .build/docs
|
|
||||||
GIT_CONFIG_EMAIL: hello@qmk.fm
|
|
||||||
@ -1,42 +0,0 @@
|
|||||||
name: Update feature branches after develop merge
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- develop
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
feature_branch_update:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
if: github.repository == 'qmk/qmk_firmware'
|
|
||||||
|
|
||||||
strategy:
|
|
||||||
matrix:
|
|
||||||
branch:
|
|
||||||
- xap
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
with:
|
|
||||||
token: ${{ secrets.QMK_BOT_TOKEN }}
|
|
||||||
fetch-depth: 0
|
|
||||||
|
|
||||||
- name: Disable automatic eol conversion
|
|
||||||
run: |
|
|
||||||
echo "* -text" > .git/info/attributes
|
|
||||||
|
|
||||||
- name: Checkout branch
|
|
||||||
run: |
|
|
||||||
git fetch origin develop ${{ matrix.branch }}
|
|
||||||
git checkout ${{ matrix.branch }}
|
|
||||||
|
|
||||||
- name: Update branch from develop
|
|
||||||
run: |
|
|
||||||
git config --global user.name "QMK Bot"
|
|
||||||
git config --global user.email "hello@qmk.fm"
|
|
||||||
git merge origin/develop
|
|
||||||
git push origin ${{ matrix.branch }}
|
|
||||||
@ -1,55 +0,0 @@
|
|||||||
name: PR Lint Format
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
paths:
|
|
||||||
- 'drivers/**'
|
|
||||||
- 'lib/arm_atsam/**'
|
|
||||||
- 'lib/lib8tion/**'
|
|
||||||
- 'lib/python/**'
|
|
||||||
- 'platforms/**'
|
|
||||||
- 'quantum/**'
|
|
||||||
- 'tests/**'
|
|
||||||
- 'tmk_core/**'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
lint:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
container: qmkfm/qmk_cli
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Disable safe.directory check
|
|
||||||
run : git config --global --add safe.directory '*'
|
|
||||||
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: |
|
|
||||||
pip3 install -r requirements-dev.txt
|
|
||||||
|
|
||||||
- name: Get changed files
|
|
||||||
id: file_changes
|
|
||||||
uses: tj-actions/changed-files@v35
|
|
||||||
|
|
||||||
- name: Run qmk formatters
|
|
||||||
shell: 'bash {0}'
|
|
||||||
run: |
|
|
||||||
echo '${{ steps.file_changes.outputs.added_files}}' '${{ steps.file_changes.outputs.modified_files}}' > ~/files_changed.txt
|
|
||||||
qmk format-c --core-only $(< ~/files_changed.txt) || true
|
|
||||||
qmk format-python $(< ~/files_changed.txt) || true
|
|
||||||
qmk format-text $(< ~/files_changed.txt) || true
|
|
||||||
|
|
||||||
- name: Fail when formatting required
|
|
||||||
run: |
|
|
||||||
git diff
|
|
||||||
for file in $(git diff --name-only); do
|
|
||||||
echo "File '${file}' Requires Formatting"
|
|
||||||
echo "::error file=${file}::Requires Formatting"
|
|
||||||
done
|
|
||||||
test -z "$(git diff --name-only)"
|
|
||||||
@ -1,59 +0,0 @@
|
|||||||
name: Lint Format
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
- develop
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
lint:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
container: qmkfm/qmk_cli
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Disable safe.directory check
|
|
||||||
run : git config --global --add safe.directory '*'
|
|
||||||
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
|
|
||||||
- name: Disable automatic eol conversion
|
|
||||||
run: |
|
|
||||||
echo "* -text" > .git/info/attributes
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: |
|
|
||||||
pip3 install -r requirements-dev.txt
|
|
||||||
|
|
||||||
- name: Run qmk formatters
|
|
||||||
shell: 'bash {0}'
|
|
||||||
run: |
|
|
||||||
qmk format-c -a
|
|
||||||
qmk format-python -a
|
|
||||||
qmk format-text -a
|
|
||||||
git diff
|
|
||||||
|
|
||||||
- uses: rlespinasse/github-slug-action@v3.x
|
|
||||||
|
|
||||||
- name: Become QMK Bot
|
|
||||||
run: |
|
|
||||||
git config user.name 'QMK Bot'
|
|
||||||
git config user.email 'hello@qmk.fm'
|
|
||||||
|
|
||||||
- name: Create Pull Request
|
|
||||||
uses: peter-evans/create-pull-request@v5
|
|
||||||
if: ${{ github.repository == 'qmk/qmk_firmware'}}
|
|
||||||
with:
|
|
||||||
token: ${{ secrets.QMK_BOT_TOKEN }}
|
|
||||||
delete-branch: true
|
|
||||||
branch: bugfix/format_${{ env.GITHUB_REF_SLUG }}
|
|
||||||
author: QMK Bot <hello@qmk.fm>
|
|
||||||
committer: QMK Bot <hello@qmk.fm>
|
|
||||||
commit-message: Format code according to conventions
|
|
||||||
title: '[CI] Format code according to conventions'
|
|
||||||
@ -1,18 +0,0 @@
|
|||||||
name: "Pull Request Labeler"
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
pull-requests: write
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request_target:
|
|
||||||
types: [opened, synchronize, reopened, ready_for_review, locked]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
triage:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/labeler@main
|
|
||||||
with:
|
|
||||||
repo-token: "${{ secrets.GITHUB_TOKEN }}"
|
|
||||||
configuration-path: '.github/labeler.yml'
|
|
||||||
@ -1,74 +0,0 @@
|
|||||||
name: PR Lint keyboards
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
paths:
|
|
||||||
- 'keyboards/**'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
lint:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
container: qmkfm/qmk_cli
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Disable safe.directory check
|
|
||||||
run : git config --global --add safe.directory '*'
|
|
||||||
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: pip3 install -r requirements-dev.txt
|
|
||||||
|
|
||||||
- name: Get changed files
|
|
||||||
id: file_changes
|
|
||||||
uses: tj-actions/changed-files@v35
|
|
||||||
|
|
||||||
- name: Print info
|
|
||||||
run: |
|
|
||||||
git rev-parse --short HEAD
|
|
||||||
echo ${{ github.event.pull_request.base.sha }}
|
|
||||||
echo '${{ steps.file_changes.outputs.all_changed_files}}'
|
|
||||||
|
|
||||||
- name: Run qmk lint
|
|
||||||
shell: 'bash {0}'
|
|
||||||
run: |
|
|
||||||
QMK_CHANGES=$(echo -e '${{ steps.file_changes.outputs.all_changed_files}}' | sed 's/ /\n/g')
|
|
||||||
QMK_KEYBOARDS=$(qmk list-keyboards)
|
|
||||||
|
|
||||||
exit_code=0
|
|
||||||
|
|
||||||
for KB in $QMK_KEYBOARDS; do
|
|
||||||
KEYBOARD_CHANGES=$(echo "$QMK_CHANGES" | grep -E '^(keyboards/'${KB}'/)')
|
|
||||||
if [[ -z "$KEYBOARD_CHANGES" ]]; then
|
|
||||||
# skip as no changes for this keyboard
|
|
||||||
continue
|
|
||||||
fi
|
|
||||||
|
|
||||||
KEYMAP_ONLY=$(echo "$KEYBOARD_CHANGES" | grep -cv /keymaps/)
|
|
||||||
if [[ $KEYMAP_ONLY -gt 0 ]]; then
|
|
||||||
echo "linting ${KB}"
|
|
||||||
|
|
||||||
qmk lint --keyboard ${KB} && qmk info -l --keyboard ${KB}
|
|
||||||
exit_code=$(($exit_code + $?))
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
qmk format-text ${{ steps.file_changes.outputs.all_changed_files}} || true
|
|
||||||
for file in ${{ steps.file_changes.outputs.all_changed_files}}; do
|
|
||||||
if ! git diff --quiet $file; then
|
|
||||||
echo "File '${file}' Requires Formatting"
|
|
||||||
echo "::error file=${file}::Requires Formatting"
|
|
||||||
exit_code=$(($exit_code + 1))
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
|
|
||||||
if [[ $exit_code -gt 255 ]]; then
|
|
||||||
exit 255
|
|
||||||
fi
|
|
||||||
exit $exit_code
|
|
||||||
@ -1,36 +0,0 @@
|
|||||||
name: PR Regenerate Files
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
paths:
|
|
||||||
- 'data/constants/**'
|
|
||||||
- 'lib/python/**'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
regen:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
container: qmkfm/qmk_cli
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Disable safe.directory check
|
|
||||||
run : git config --global --add safe.directory '*'
|
|
||||||
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: Run qmk generators
|
|
||||||
run: |
|
|
||||||
util/regen.sh
|
|
||||||
git diff
|
|
||||||
|
|
||||||
- name: Fail when regeneration required
|
|
||||||
run: |
|
|
||||||
git diff
|
|
||||||
for file in $(git diff --name-only); do
|
|
||||||
echo "File '${file}' Requires Regeneration"
|
|
||||||
echo "::error file=${file}::Requires Regeneration"
|
|
||||||
done
|
|
||||||
test -z "$(git diff --name-only)"
|
|
||||||
@ -1,46 +0,0 @@
|
|||||||
name: Regenerate Files
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
- develop
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
regen:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
container: qmkfm/qmk_cli
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Disable safe.directory check
|
|
||||||
run : git config --global --add safe.directory '*'
|
|
||||||
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: Run qmk generators
|
|
||||||
run: |
|
|
||||||
util/regen.sh
|
|
||||||
git diff
|
|
||||||
|
|
||||||
- uses: rlespinasse/github-slug-action@v3.x
|
|
||||||
|
|
||||||
- name: Become QMK Bot
|
|
||||||
run: |
|
|
||||||
git config user.name 'QMK Bot'
|
|
||||||
git config user.email 'hello@qmk.fm'
|
|
||||||
|
|
||||||
- name: Create Pull Request
|
|
||||||
uses: peter-evans/create-pull-request@v5
|
|
||||||
if: ${{ github.repository == 'qmk/qmk_firmware'}}
|
|
||||||
with:
|
|
||||||
token: ${{ secrets.QMK_BOT_TOKEN }}
|
|
||||||
delete-branch: true
|
|
||||||
branch: bugfix/regen_${{ env.GITHUB_REF_SLUG }}
|
|
||||||
author: QMK Bot <hello@qmk.fm>
|
|
||||||
committer: QMK Bot <hello@qmk.fm>
|
|
||||||
commit-message: Regenerate Files
|
|
||||||
title: '[CI] Regenerate Files'
|
|
||||||
@ -1,65 +0,0 @@
|
|||||||
name: 'Close stale issues and PRs'
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
issues: write
|
|
||||||
pull-requests: write
|
|
||||||
|
|
||||||
on:
|
|
||||||
schedule:
|
|
||||||
- cron: '30 1 * * *'
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
stale:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/stale@v8
|
|
||||||
with:
|
|
||||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
|
|
||||||
remove-stale-when-updated: true
|
|
||||||
exempt-draft-pr: true
|
|
||||||
ascending: true
|
|
||||||
operations-per-run: 150
|
|
||||||
|
|
||||||
stale-issue-label: stale
|
|
||||||
days-before-issue-stale: 90
|
|
||||||
days-before-issue-close: 30
|
|
||||||
exempt-issue-labels: bug,in progress,on hold,discussion,to do
|
|
||||||
|
|
||||||
stale-issue-message: >
|
|
||||||
This issue has been automatically marked as stale because it has not had activity in the
|
|
||||||
last 90 days. It will be closed in the next 30 days unless it is tagged properly or other activity
|
|
||||||
occurs.
|
|
||||||
|
|
||||||
For maintainers: Please label with `bug`, `in progress`, `on hold`, `discussion` or `to do` to prevent
|
|
||||||
the issue from being re-flagged.
|
|
||||||
|
|
||||||
close-issue-message: >
|
|
||||||
This issue has been automatically closed because it has not had activity in the last 30 days.
|
|
||||||
If this issue is still valid, re-open the issue and let us know.
|
|
||||||
|
|
||||||
// [stale-action-closed]
|
|
||||||
|
|
||||||
stale-pr-label: stale
|
|
||||||
days-before-pr-stale: 45
|
|
||||||
days-before-pr-close: 30
|
|
||||||
exempt-pr-labels: bug,awaiting review,breaking_change,in progress,on hold
|
|
||||||
|
|
||||||
stale-pr-message: >
|
|
||||||
Thank you for your contribution!
|
|
||||||
|
|
||||||
This pull request has been automatically marked as stale because it has not had
|
|
||||||
activity in the last 45 days. It will be closed in 30 days if no further activity occurs.
|
|
||||||
Please feel free to give a status update now, or re-open when it's ready.
|
|
||||||
|
|
||||||
For maintainers: Please label with `bug`, `awaiting review`, `breaking_change`, `in progress`, or `on hold`
|
|
||||||
to prevent the issue from being re-flagged.
|
|
||||||
|
|
||||||
close-pr-message: >
|
|
||||||
Thank you for your contribution!
|
|
||||||
|
|
||||||
This pull request has been automatically closed because it has not had activity in the last 30 days.
|
|
||||||
Please feel free to give a status update now, ping for review, or re-open when it's ready.
|
|
||||||
|
|
||||||
// [stale-action-closed]
|
|
||||||
@ -1,35 +0,0 @@
|
|||||||
name: Unit Tests
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
- develop
|
|
||||||
pull_request:
|
|
||||||
paths:
|
|
||||||
- 'builddefs/**'
|
|
||||||
- 'quantum/**'
|
|
||||||
- 'platforms/**'
|
|
||||||
- 'tmk_core/**'
|
|
||||||
- 'tests/**'
|
|
||||||
- '*.mk'
|
|
||||||
- 'Makefile'
|
|
||||||
- '.github/workflows/unit_test.yml'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
test:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
container: qmkfm/qmk_cli
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
with:
|
|
||||||
submodules: recursive
|
|
||||||
- name: Install dependencies
|
|
||||||
run: pip3 install -r requirements-dev.txt
|
|
||||||
- name: Run tests
|
|
||||||
run: make test:all
|
|
||||||
@ -1,36 +0,0 @@
|
|||||||
# Quantum Mechanical Keyboard Firmware
|
|
||||||
|
|
||||||
[](https://github.com/qmk/qmk_firmware/tags)
|
|
||||||
[](https://discord.gg/Uq7gcHh)
|
|
||||||
[](https://docs.qmk.fm)
|
|
||||||
[](https://github.com/qmk/qmk_firmware/pulse/monthly)
|
|
||||||
[](https://github.com/qmk/qmk_firmware/)
|
|
||||||
|
|
||||||
This is a keyboard firmware based on the [tmk\_keyboard firmware](https://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR and ARM controllers, and more specifically, the [OLKB product line](https://olkb.com), the [ErgoDox EZ](https://ergodox-ez.com) keyboard, and the [Clueboard product line](https://clueboard.co).
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
|
|
||||||
* [See the official documentation on docs.qmk.fm](https://docs.qmk.fm)
|
|
||||||
|
|
||||||
The docs are powered by [Docsify](https://docsify.js.org/) and hosted on [GitHub](/docs/). They are also viewable offline; see [Previewing the Documentation](https://docs.qmk.fm/#/contributing?id=previewing-the-documentation) for more details.
|
|
||||||
|
|
||||||
You can request changes by making a fork and opening a [pull request](https://github.com/qmk/qmk_firmware/pulls), or by clicking the "Edit this page" link at the bottom of any page.
|
|
||||||
|
|
||||||
## Supported Keyboards
|
|
||||||
|
|
||||||
* [Planck](/keyboards/planck/)
|
|
||||||
* [Preonic](/keyboards/preonic/)
|
|
||||||
* [ErgoDox EZ](/keyboards/ergodox_ez/)
|
|
||||||
* [Clueboard](/keyboards/clueboard/)
|
|
||||||
* [Cluepad](/keyboards/clueboard/17/)
|
|
||||||
* [Atreus](/keyboards/atreus/)
|
|
||||||
|
|
||||||
The project also includes community support for [lots of other keyboards](/keyboards/).
|
|
||||||
|
|
||||||
## Maintainers
|
|
||||||
|
|
||||||
QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, [Hasu](https://github.com/tmk). The OLKB product firmwares are maintained by [Jack Humbert](https://github.com/jackhumbert), the Ergodox EZ by [ZSA Technology Labs](https://github.com/zsa), the Clueboard by [Zach White](https://github.com/skullydazed), and the Atreus by [Phil Hagelberg](https://github.com/technomancy).
|
|
||||||
|
|
||||||
## Official Website
|
|
||||||
|
|
||||||
[qmk.fm](https://qmk.fm) is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.
|
|
||||||
Loading…
Reference in New Issue