mirror of
https://github.com/openstenoproject/qmk
synced 2024-11-08 17:29:09 +00:00
Merge remote-tracking branch 'origin/master' into develop
This commit is contained in:
commit
92e606b927
13 changed files with 16 additions and 17 deletions
2
.github/workflows/api.yml
vendored
2
.github/workflows/api.yml
vendored
|
@ -12,7 +12,7 @@ on:
|
||||||
jobs:
|
jobs:
|
||||||
api_data:
|
api_data:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
container: qmkfm/base_container
|
container: qmkfm/qmk_cli
|
||||||
|
|
||||||
# protect against those who develop with their fork on master
|
# protect against those who develop with their fork on master
|
||||||
if: github.repository == 'qmk/qmk_firmware'
|
if: github.repository == 'qmk/qmk_firmware'
|
||||||
|
|
4
.github/workflows/cli.yml
vendored
4
.github/workflows/cli.yml
vendored
|
@ -16,7 +16,7 @@ jobs:
|
||||||
test:
|
test:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
container: qmkfm/base_container
|
container: qmkfm/qmk_cli
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
|
@ -25,4 +25,4 @@ jobs:
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: pip3 install -r requirements-dev.txt
|
run: pip3 install -r requirements-dev.txt
|
||||||
- name: Run tests
|
- name: Run tests
|
||||||
run: bin/qmk pytest
|
run: qmk pytest
|
||||||
|
|
2
.github/workflows/develop_api.yml
vendored
2
.github/workflows/develop_api.yml
vendored
|
@ -12,7 +12,7 @@ on:
|
||||||
jobs:
|
jobs:
|
||||||
api_data:
|
api_data:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
container: qmkfm/base_container
|
container: qmkfm/qmk_cli
|
||||||
|
|
||||||
# protect against those who work in their fork on develop
|
# protect against those who work in their fork on develop
|
||||||
if: github.repository == 'qmk/qmk_firmware'
|
if: github.repository == 'qmk/qmk_firmware'
|
||||||
|
|
2
.github/workflows/docs.yml
vendored
2
.github/workflows/docs.yml
vendored
|
@ -14,7 +14,7 @@ on:
|
||||||
jobs:
|
jobs:
|
||||||
generate:
|
generate:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
container: qmkfm/base_container
|
container: qmkfm/qmk_cli
|
||||||
|
|
||||||
# protect against those who develop with their fork on master
|
# protect against those who develop with their fork on master
|
||||||
if: github.repository == 'qmk/qmk_firmware'
|
if: github.repository == 'qmk/qmk_firmware'
|
||||||
|
|
2
.github/workflows/format.yaml
vendored
2
.github/workflows/format.yaml
vendored
|
@ -16,7 +16,7 @@ jobs:
|
||||||
lint:
|
lint:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
container: qmkfm/base_container
|
container: qmkfm/qmk_cli
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: rlespinasse/github-slug-action@v3.x
|
- uses: rlespinasse/github-slug-action@v3.x
|
||||||
|
|
2
.github/workflows/lint.yml
vendored
2
.github/workflows/lint.yml
vendored
|
@ -9,7 +9,7 @@ jobs:
|
||||||
lint:
|
lint:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
container: qmkfm/base_container
|
container: qmkfm/qmk_cli
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
|
|
|
@ -1,7 +1,6 @@
|
||||||
FROM qmkfm/base_container
|
FROM qmkfm/qmk_cli
|
||||||
|
|
||||||
VOLUME /qmk_firmware
|
VOLUME /qmk_firmware
|
||||||
WORKDIR /qmk_firmware
|
WORKDIR /qmk_firmware
|
||||||
COPY . .
|
|
||||||
|
|
||||||
CMD make all:default
|
CMD qmk compile -kb all -km default
|
||||||
|
|
4
Vagrantfile
vendored
4
Vagrantfile
vendored
|
@ -68,13 +68,13 @@ Vagrant.configure(2) do |config|
|
||||||
["virtualbox", "vmware_workstation", "vmware_fusion"].each do |type|
|
["virtualbox", "vmware_workstation", "vmware_fusion"].each do |type|
|
||||||
config.vm.provider type do |virt, override|
|
config.vm.provider type do |virt, override|
|
||||||
override.vm.provision "docker" do |d|
|
override.vm.provision "docker" do |d|
|
||||||
d.run "qmkfm/base_container",
|
d.run "qmkfm/qmk_cli",
|
||||||
cmd: "tail -f /dev/null",
|
cmd: "tail -f /dev/null",
|
||||||
args: "--privileged -v /dev:/dev -v '/vagrant:/vagrant'"
|
args: "--privileged -v /dev:/dev -v '/vagrant:/vagrant'"
|
||||||
end
|
end
|
||||||
|
|
||||||
override.vm.provision "shell", inline: <<-SHELL
|
override.vm.provision "shell", inline: <<-SHELL
|
||||||
echo 'docker restart qmkfm-base_container && exec docker exec -it qmkfm-base_container /bin/bash -l' >> ~vagrant/.bashrc
|
echo 'docker restart qmkfm-qmk_cli && exec docker exec -it qmkfm-qmk_cli /bin/bash -l' >> ~vagrant/.bashrc
|
||||||
SHELL
|
SHELL
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
|
@ -24,7 +24,7 @@ The "easy" way to flash the firmware is using a tool from your host OS:
|
||||||
If you want to program via the command line you can uncomment the ['modifyvm'] lines in the Vagrantfile to enable the USB passthrough into Linux and then program using the command line tools like dfu-util/dfu-programmer or you can install the Teensy CLI version.
|
If you want to program via the command line you can uncomment the ['modifyvm'] lines in the Vagrantfile to enable the USB passthrough into Linux and then program using the command line tools like dfu-util/dfu-programmer or you can install the Teensy CLI version.
|
||||||
|
|
||||||
## Vagrantfile Overview
|
## Vagrantfile Overview
|
||||||
The development environment is configured to run the QMK Docker image, `qmkfm/base_container`. This not only ensures predictability between systems, it also mirrors the CI environment.
|
The development environment is configured to run the QMK Docker image, `qmkfm/qmk_cli`. This not only ensures predictability between systems, it also mirrors the CI environment.
|
||||||
|
|
||||||
## FAQ
|
## FAQ
|
||||||
|
|
||||||
|
|
|
@ -29,7 +29,7 @@ Vagrant 以外に、適切なプロバイダがインストールされ、その
|
||||||
コマンドラインでプログラムしたい場合は、Vagranfile の ['modifyvm'] 行のコメントを解除して Linux への USB パススルーを有効にし、dfu-util/dfu-programmer のようなコマンドラインツールを使ってプログラムすることができます。あるいは Teensy CLI バージョンをインストールすることができます。
|
コマンドラインでプログラムしたい場合は、Vagranfile の ['modifyvm'] 行のコメントを解除して Linux への USB パススルーを有効にし、dfu-util/dfu-programmer のようなコマンドラインツールを使ってプログラムすることができます。あるいは Teensy CLI バージョンをインストールすることができます。
|
||||||
|
|
||||||
## Vagrantfile の概要
|
## Vagrantfile の概要
|
||||||
開発環境は QMK Docker イメージ、`qmkfm/base_container` を実行するように設定されています。これはシステム間の予測可能性が保証されるだけでなく、CI 環境もミラーされます。
|
開発環境は QMK Docker イメージ、`qmkfm/qmk_cli` を実行するように設定されています。これはシステム間の予測可能性が保証されるだけでなく、CI 環境もミラーされます。
|
||||||
|
|
||||||
## FAQ
|
## FAQ
|
||||||
|
|
||||||
|
|
|
@ -81,5 +81,5 @@ fi
|
||||||
-e ALT_GET_KEYBOARDS=true \
|
-e ALT_GET_KEYBOARDS=true \
|
||||||
-e SKIP_GIT="$SKIP_GIT" \
|
-e SKIP_GIT="$SKIP_GIT" \
|
||||||
-e MAKEFLAGS="$MAKEFLAGS" \
|
-e MAKEFLAGS="$MAKEFLAGS" \
|
||||||
qmkfm/base_container \
|
qmkfm/qmk_cli \
|
||||||
make "$keyboard${keymap:+:$keymap}${target:+:$target}"
|
make "$keyboard${keymap:+:$keymap}${target:+:$target}"
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
FROM qmkfm/base_container
|
FROM qmkfm/qmk_cli
|
||||||
|
|
||||||
# Basic upgrades; install sudo and SSH.
|
# Basic upgrades; install sudo and SSH.
|
||||||
RUN apt-get update && apt-get install --no-install-recommends -y \
|
RUN apt-get update && apt-get install --no-install-recommends -y \
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
# QMK Vagrant Utilities
|
# QMK Vagrant Utilities
|
||||||
|
|
||||||
## Dockerfile
|
## Dockerfile
|
||||||
Vagrant-friendly `qmkfm/base_container`.
|
Vagrant-friendly `qmkfm/qmk_cli`.
|
||||||
|
|
||||||
In order for the Docker provider and `vagrant ssh` to function the container has a few extra requirements.
|
In order for the Docker provider and `vagrant ssh` to function the container has a few extra requirements.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue