From b705020dafd0aa7531d03cd8fa64260684a3fb79 Mon Sep 17 00:00:00 2001 From: Zach White Date: Sun, 29 Aug 2021 16:41:56 -0700 Subject: [PATCH] move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) --- .github/workflows/api.yml | 2 +- .github/workflows/cli.yml | 4 ++-- .github/workflows/develop_api.yml | 2 +- .github/workflows/docs.yml | 2 +- .github/workflows/format.yaml | 2 +- .github/workflows/lint.yml | 2 +- Dockerfile | 5 ++--- Vagrantfile | 4 ++-- docs/getting_started_vagrant.md | 2 +- docs/ja/getting_started_vagrant.md | 2 +- util/docker_build.sh | 2 +- util/vagrant/Dockerfile | 2 +- util/vagrant/readme.md | 2 +- 13 files changed, 16 insertions(+), 17 deletions(-) diff --git a/.github/workflows/api.yml b/.github/workflows/api.yml index 07da3f0faf..a19667f97e 100644 --- a/.github/workflows/api.yml +++ b/.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' diff --git a/.github/workflows/cli.yml b/.github/workflows/cli.yml index df727518e5..7a8dc8540f 100644 --- a/.github/workflows/cli.yml +++ b/.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 diff --git a/.github/workflows/develop_api.yml b/.github/workflows/develop_api.yml index 45c2ed6be6..f0098142c7 100644 --- a/.github/workflows/develop_api.yml +++ b/.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' diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 8855d1107f..1ee3ae3964 100644 --- a/.github/workflows/docs.yml +++ b/.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' diff --git a/.github/workflows/format.yaml b/.github/workflows/format.yaml index 351c3ff997..0bb8701068 100644 --- a/.github/workflows/format.yaml +++ b/.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 diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index cd67de9d8b..c7a8624ee1 100644 --- a/.github/workflows/lint.yml +++ b/.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 diff --git a/Dockerfile b/Dockerfile index 17831c4ec3..e283c8f98a 100644 --- a/Dockerfile +++ b/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 diff --git a/Vagrantfile b/Vagrantfile index 8125b05890..717f4ec98b 100644 --- a/Vagrantfile +++ b/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 diff --git a/docs/getting_started_vagrant.md b/docs/getting_started_vagrant.md index b71f8908b9..114f875671 100644 --- a/docs/getting_started_vagrant.md +++ b/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 diff --git a/docs/ja/getting_started_vagrant.md b/docs/ja/getting_started_vagrant.md index 4506bb1faf..0888b7f311 100644 --- a/docs/ja/getting_started_vagrant.md +++ b/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 diff --git a/util/docker_build.sh b/util/docker_build.sh index 2b109be76d..8a6b2d0565 100755 --- a/util/docker_build.sh +++ b/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}" diff --git a/util/vagrant/Dockerfile b/util/vagrant/Dockerfile index 1936ee023a..951d4fc40d 100644 --- a/util/vagrant/Dockerfile +++ b/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 \ diff --git a/util/vagrant/readme.md b/util/vagrant/readme.md index e4b870a642..a8396007ee 100644 --- a/util/vagrant/readme.md +++ b/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.