Browse Source

move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230)

master
Zach White 10 months ago
committed by GitHub
parent
commit
b705020daf
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 2
      .github/workflows/api.yml
  2. 4
      .github/workflows/cli.yml
  3. 2
      .github/workflows/develop_api.yml
  4. 2
      .github/workflows/docs.yml
  5. 2
      .github/workflows/format.yaml
  6. 2
      .github/workflows/lint.yml
  7. 5
      Dockerfile
  8. 4
      Vagrantfile
  9. 2
      docs/getting_started_vagrant.md
  10. 2
      docs/ja/getting_started_vagrant.md
  11. 2
      util/docker_build.sh
  12. 2
      util/vagrant/Dockerfile
  13. 2
      util/vagrant/readme.md

2
.github/workflows/api.yml

@ -12,7 +12,7 @@ on:
jobs:
api_data:
runs-on: ubuntu-latest
container: qmkfm/base_container
container: qmkfm/qmk_cli
# protect against those who develop with their fork on master
if: github.repository == 'qmk/qmk_firmware'

4
.github/workflows/cli.yml

@ -16,7 +16,7 @@ jobs:
test:
runs-on: ubuntu-latest
container: qmkfm/base_container
container: qmkfm/qmk_cli
steps:
- uses: actions/checkout@v2
@ -25,4 +25,4 @@ jobs:
- name: Install dependencies
run: pip3 install -r requirements-dev.txt
- name: Run tests
run: bin/qmk pytest
run: qmk pytest

2
.github/workflows/develop_api.yml

@ -12,7 +12,7 @@ on:
jobs:
api_data:
runs-on: ubuntu-latest
container: qmkfm/base_container
container: qmkfm/qmk_cli
# protect against those who work in their fork on develop
if: github.repository == 'qmk/qmk_firmware'

2
.github/workflows/docs.yml

@ -14,7 +14,7 @@ on:
jobs:
generate:
runs-on: ubuntu-latest
container: qmkfm/base_container
container: qmkfm/qmk_cli
# protect against those who develop with their fork on master
if: github.repository == 'qmk/qmk_firmware'

2
.github/workflows/format.yaml

@ -16,7 +16,7 @@ jobs:
lint:
runs-on: ubuntu-latest
container: qmkfm/base_container
container: qmkfm/qmk_cli
steps:
- uses: rlespinasse/github-slug-action@v3.x

2
.github/workflows/lint.yml

@ -9,7 +9,7 @@ jobs:
lint:
runs-on: ubuntu-latest
container: qmkfm/base_container
container: qmkfm/qmk_cli
steps:
- uses: actions/checkout@v2

5
Dockerfile

@ -1,7 +1,6 @@
FROM qmkfm/base_container
FROM qmkfm/qmk_cli
VOLUME /qmk_firmware
WORKDIR /qmk_firmware
COPY . .
CMD make all:default
CMD qmk compile -kb all -km default

4
Vagrantfile

@ -68,13 +68,13 @@ Vagrant.configure(2) do |config|
["virtualbox", "vmware_workstation", "vmware_fusion"].each do |type|
config.vm.provider type do |virt, override|
override.vm.provision "docker" do |d|
d.run "qmkfm/base_container",
d.run "qmkfm/qmk_cli",
cmd: "tail -f /dev/null",
args: "--privileged -v /dev:/dev -v '/vagrant:/vagrant'"
end
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
end
end

2
docs/getting_started_vagrant.md

@ -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.
## 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

2
docs/ja/getting_started_vagrant.md

@ -29,7 +29,7 @@ Vagrant 以外に、適切なプロバイダがインストールされ、その
コマンドラインでプログラムしたい場合は、Vagranfile の ['modifyvm'] 行のコメントを解除して Linux への USB パススルーを有効にし、dfu-util/dfu-programmer のようなコマンドラインツールを使ってプログラムすることができます。あるいは Teensy CLI バージョンをインストールすることができます。
## Vagrantfile の概要
開発環境は QMK Docker イメージ、`qmkfm/base_container` を実行するように設定されています。これはシステム間の予測可能性が保証されるだけでなく、CI 環境もミラーされます。
開発環境は QMK Docker イメージ、`qmkfm/qmk_cli` を実行するように設定されています。これはシステム間の予測可能性が保証されるだけでなく、CI 環境もミラーされます。
## FAQ

2
util/docker_build.sh

@ -81,5 +81,5 @@ fi
-e ALT_GET_KEYBOARDS=true \
-e SKIP_GIT="$SKIP_GIT" \
-e MAKEFLAGS="$MAKEFLAGS" \
qmkfm/base_container \
qmkfm/qmk_cli \
make "$keyboard${keymap:+:$keymap}${target:+:$target}"

2
util/vagrant/Dockerfile

@ -1,4 +1,4 @@
FROM qmkfm/base_container
FROM qmkfm/qmk_cli
# Basic upgrades; install sudo and SSH.
RUN apt-get update && apt-get install --no-install-recommends -y \

2
util/vagrant/readme.md

@ -1,7 +1,7 @@
# QMK Vagrant Utilities
## 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.

Loading…
Cancel
Save