Remove duplication of ssh keys and fix usage on PR builds (#5013)

* docker_build.sh: Run container in interactive mode

* Add message about QMK Toolbox

* Update Docker docs

.github/ISSUE_TEMPLATE/bug_report.md

@@ -2,30 +2,31 @@
 name: Bug report
 about: Create a report to help us improve the QMK Firmware
 ---
-<!-- Provide a general summary of the bug in the Title above -->
+<!-- Provide a general summary of the bug in the title above. -->
 
-<!-- This template is entirely option and can be removed, but is here to help both you and us. -->
+<!--- This template is entirely optional and can be removed, but is here to help both you and us. -->
-<!-- This text and anything on lines wrapped like this one will not show up in the final text. This text is to help us and you. -->
+<!--- Anything on lines wrapped in comments like these will not show up in the final text. -->
 
-**Describe the bug**
+## Describe the Bug
 
 <!-- A clear and concise description of what the bug is. -->
 
-**System Information**
+## System Information
+
  - Keyboard:  
    - Revision (if applicable):  
- - Operating System:
+ - Operating system:
- - avr-gcc version: 
+ - AVR GCC version: 
-<!-- Run `avr-gcc --version` to find out -->
+<!-- Run `avr-gcc --version` to find this out. -->
- - arm gcc version: 
+ - ARM GCC version: 
-<!-- Run `arm-none-eabi-gcc --version` to find out -->
+<!-- Run `arm-none-eabi-gcc --version` to find this out. -->
  - QMK Firmware version:
-<!-- You can run `git describe --abbrev=0 --tags` to find this out -->
+<!-- Run `git describe --abbrev=0 --tags` to find this out. -->
  - Any keyboard related software installed? 
-   - [ ] Auto Hot Key
+   - [ ] AutoHotKey
    - [ ] Karabiner
-   - [ ] Other
+   - [ ] Other:
 
-**Additional context**
+## Additional Context
 
-<!-- Add any other context about the problem here. --> 
+<!-- Add any other relevant information about the problem here. -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -2,18 +2,18 @@
 name: Feature request
 about: Suggest a new feature or changes to existing features 
 ---
-<!--- Provide a general summary of the changes you want in the Title above -->
+<!--- Provide a general summary of the changes you want in the title above. -->
 
-<!-- This template is entirely option and can be removed, but is here to help both you and us. -->
+<!--- This template is entirely optional and can be removed, but is here to help both you and us. -->
-<!-- This text and anything on lines wrapped like this one will not show up in the final text. This text is to help us and you. -->
+<!--- Anything on lines wrapped in comments like these will not show up in the final text. -->
 
 ## Feature Request Type
 
-- [ ] Core Functionality
+- [ ] Core functionality
-- [ ] Add-on hardware support (e.g. audio, RGB, OLED screen, etc.)
+- [ ] Add-on hardware support (eg. audio, RGB, OLED screen, etc.)
-- [ ] Alteration (enhancement/optimization) of existing Feature(s)
+- [ ] Alteration (enhancement/optimization) of existing feature(s)
 - [ ] New behavior
 
 ## Description
 
-<!-- A few sentences describing what it is that you'd like to see. Additional information (such as links to spec sheets, licensing info, other related issues or PR's, etc) would be helpful. -->
+<!-- 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. -->

.github/ISSUE_TEMPLATE/other_issues.md

@@ -2,8 +2,8 @@
 name: Other issues
 about: Anything else that doesn't fall into the above categories. 
 ---
-<!--- Provide a general summary of the changes you want in the Title above -->
+<!--- Provide a general summary of the changes you want in the title above. -->
 
-<!-- This text and anything on lines wrapped like this one will not show up in the final text. This text is to help us and you. -->
+<!--- Anything on lines wrapped in comments like these will not show up in the final text. -->
 
-<!-- Please check https://docs.qmk.fm/#/support for additional resources first. If that doesn't answer your question, check the bug report option, as that may be more appropriate. -->
+<!-- Please check 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. -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,32 +1,34 @@
-<!--- Provide a general summary of your changes in the Title above -->
+<!--- Provide a general summary of your changes in the title above. -->
 
-<!--- This template is entirely option and can be removed, but is here to help both you and us. -->
+<!--- This template is entirely optional and can be removed, but is here to help both you and us. -->
-<!--- This text and anything on lines wrapped like this one will not show up in the final text. This text is to help us and you. -->
+<!--- Anything on lines wrapped in comments like these will not show up in the final text. -->
 
 ## Description
-<!--- Describe your changes in detail -->
 
-## Types of changes
+<!--- Describe your changes in detail here. -->
-<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+
+## Types of Changes
+
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply. -->
 - [ ] Core
 - [ ] Bugfix
-- [ ] New Feature
+- [ ] New feature
-- [ ] Enhancement/Optimization
+- [ ] Enhancement/optimization
 - [ ] Keyboard (addition or update)
-- [ ] Keymap/Layout/Userspace (addition or update)
+- [ ] Keymap/layout/userspace (addition or update)
 - [ ] Documentation
 
-
+## Issues Fixed or Closed by This PR
-## Issues Fixed or Closed by this PR
 
 * 
 
-## Checklist:
+## 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.
 - [ ] 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 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).

docs/feature_encoders.md

@@ -38,7 +38,7 @@ or `keymap.c`:
         } else {
           tap_code(KC_PGUP);
         }
-      } else if (index == 2) {
+      } else if (index == 1) { /* Second encoder
         if (clockwise) {
           tap_code(KC_UP);
         } else {

docs/getting_started_build_tools.md

@@ -129,12 +129,12 @@ If you have trouble and want to ask for help, it is useful to generate a *Win_Ch
 
 ## Docker
 
-If this is a bit complex for you, Docker might be the turn-key solution you need. After installing [Docker CE](https://docs.docker.com/install/#supported-platforms), run the following command from the `qmk_firmware` directory to build a keyboard/keymap:
+If this is a bit complex for you, Docker might be the turnkey solution you need. After installing [Docker CE](https://docs.docker.com/install/#supported-platforms), run the following command from the `qmk_firmware` directory to build a keyboard/keymap:
 ```bash
 util/docker_build.sh keyboard:keymap
 # For example: util/docker_build.sh ergodox_ez:steno
 ```
-This will compile the targeted keyboard/keymap and leave the resulting `.hex` or `.bin` file in the QMK directory for you to flash. If `:keymap` is omitted, the `default` keymap is used. Note that the parameter format is the same as when building with `make`.
+This will compile the desired keyboard/keymap and leave the resulting `.hex` or `.bin` file in the QMK directory for you to flash. If `:keymap` is omitted, the `default` keymap is used. Note that the parameter format is the same as when building with `make`.
 
 You can also start the script without any parameters, in which case it will ask you to input the build parameters one by one, which you may find easier to use:
 ```bash
@@ -147,7 +147,7 @@ There is also support for building _and_ flashing the keyboard straight from Doc
 util/docker_build.sh keyboard:keymap:target
 # For example: util/docker_build.sh planck/rev6:default:dfu-util
 ```
-If you're on Linux, this should work out of the box. On Windows and macOS, it requires [Docker Machine](http://gw.tnode.com/docker/docker-machine-with-usb-support-on-windows-macos/) to be running. This is tedious to set up, so it's not recommended; use QMK Toolbox instead.
+If you're on Linux, this should work out of the box. On Windows and macOS, it requires [Docker Machine](http://gw.tnode.com/docker/docker-machine-with-usb-support-on-windows-macos/) to be running. This is tedious to set up, so it's not recommended; use [QMK Toolbox](https://github.com/qmk/qmk_toolbox) instead.
 
 !> Docker for Windows requires [Hyper-V](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v) to be enabled. This means that it cannot work on versions of Windows which don't have Hyper-V, such as Windows 7, Windows 8 and **Windows 10 Home**.
 

keyboards/converter/ibm_terminal/keymaps/default/rules.mk

@@ -12,7 +12,6 @@ BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
 MIDI_ENABLE = no            # MIDI controls
 AUDIO_ENABLE = no           # Audio output on port C6
 UNICODE_ENABLE = no         # Unicode
-UNICODEMAP_ENABLE = yes
 BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
 RGBLIGHT_ENABLE = no        # Enable WS2812 RGB underlight.
 PS2_USE_USART = yes

keyboards/converter/ibm_terminal/rules.mk

@@ -58,7 +58,6 @@ BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
 MIDI_ENABLE = no            # MIDI controls
 AUDIO_ENABLE = no           # Audio output on port C6
 UNICODE_ENABLE = no         # Unicode
-UNICODEMAP_ENABLE = yes
 BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
 RGBLIGHT_ENABLE = no        # Enable WS2812 RGB underlight.
 PS2_USE_USART = yes

keyboards/converter/palm_usb/rules.mk

@@ -22,7 +22,6 @@ BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
 MIDI_ENABLE = no            # MIDI controls
 AUDIO_ENABLE = no           # Audio output on port C6
 UNICODE_ENABLE = no         # Unicode
-UNICODEMAP_ENABLE = no
 BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
 RGBLIGHT_ENABLE = no        # Enable WS2812 RGB underlight.
 # Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE

keyboards/converter/sun_usb/rules.mk

@@ -22,7 +22,6 @@ BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
 MIDI_ENABLE = no            # MIDI controls
 AUDIO_ENABLE = no           # Audio output on port C6
 UNICODE_ENABLE = no         # Unicode
-UNICODEMAP_ENABLE = yes
 BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
 RGBLIGHT_ENABLE = no        # Enable WS2812 RGB underlight.
 # Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE

keyboards/kbdfans/kbd75/rev1/rev1.c

@@ -1,14 +1,14 @@
 #include "rev1.h"
 
 void led_set_kb(uint8_t usb_led) {
-	// put your keyboard LED indicator (ex: Caps Lock LED) toggling code here
+  // put your keyboard LED indicator (ex: Caps Lock LED) toggling code here
   if (IS_LED_ON(usb_led, USB_LED_CAPS_LOCK)) {
-    writePinHigh(B2);
-  } else {
     writePinLow(B2);
+  } else {
+    writePinHigh(B2);
   }
 
-	led_set_user(usb_led);
+  led_set_user(usb_led);
 }
 
 void matrix_init_kb(void) {

keyboards/kbdfans/kbd75/rev2/rev2.c

@@ -1,14 +1,14 @@
 #include "rev2.h"
 
 void led_set_kb(uint8_t usb_led) {
-	// put your keyboard LED indicator (ex: Caps Lock LED) toggling code here
+  // put your keyboard LED indicator (ex: Caps Lock LED) toggling code here
   if (IS_LED_ON(usb_led, USB_LED_CAPS_LOCK)) {
-    writePinHigh(B2);
-  } else {
     writePinLow(B2);
+  } else {
+    writePinHigh(B2);
   }
 
-	led_set_user(usb_led);
+  led_set_user(usb_led);
 }
 
 void matrix_init_kb(void) {

quantum/process_keycode/process_unicodemap.c

@@ -17,9 +17,6 @@
 #include "process_unicodemap.h"
 #include "process_unicode_common.h"
 
-__attribute__((weak))
-const uint32_t PROGMEM unicode_map[] = {};
-
 void register_hex32(uint32_t hex) {
   bool onzerostart = true;
   for(int i = 7; i >= 0; i--) {

quantum/process_keycode/process_unicodemap.h

@@ -19,5 +19,7 @@
 #include "quantum.h"
 #include "process_unicode_common.h"
 
+extern const uint32_t PROGMEM unicode_map[];
+
 void unicodemap_input_error(void);
 bool process_unicodemap(uint16_t keycode, keyrecord_t *record);

quantum/rgblight.c

@@ -58,6 +58,7 @@ const uint16_t RGBLED_GRADIENT_RANGES[] PROGMEM = {360, 240, 180, 120, 90};
 #endif
 
 rgblight_config_t rgblight_config;
+bool is_rgblight_initialized = false;
 
 LED_TYPE led[RGBLED_NUM];
 bool rgblight_timer_enabled = false;
@@ -123,6 +124,35 @@ void setrgb(uint8_t r, uint8_t g, uint8_t b, LED_TYPE *led1) {
   (*led1).b = b;
 }
 
+void rgblight_check_config(void) {
+  /* Add some out of bound checks for RGB light config */
+
+  if (rgblight_config.mode < RGBLIGHT_MODE_STATIC_LIGHT) {
+    rgblight_config.mode = RGBLIGHT_MODE_STATIC_LIGHT;
+  }
+  else if (rgblight_config.mode > RGBLIGHT_MODES) {
+    rgblight_config.mode = RGBLIGHT_MODES;
+  }
+
+  if (rgblight_config.hue < 0) {
+    rgblight_config.hue = 0;
+  } else if (rgblight_config.hue > 360) {
+    rgblight_config.hue %= 360;
+  }
+
+  if (rgblight_config.sat < 0) {
+    rgblight_config.sat = 0;
+  } else if (rgblight_config.sat > 255) {
+    rgblight_config.sat = 255;
+  }
+
+  if (rgblight_config.val < 0) {
+    rgblight_config.val = 0;
+  } else if (rgblight_config.val > RGBLIGHT_LIMIT_VAL) {
+    rgblight_config.val = RGBLIGHT_LIMIT_VAL;
+  }
+
+}
 
 uint32_t eeconfig_read_rgblight(void) {
   #if defined(__AVR__) || defined(STM32_EEPROM_ENABLE) || defined(PROTOCOL_ARM_ATSAM) || defined(EEPROM_SIZE)
@@ -131,13 +161,14 @@ uint32_t eeconfig_read_rgblight(void) {
     return 0;
   #endif
 }
+
 void eeconfig_update_rgblight(uint32_t val) {
   #if defined(__AVR__) || defined(STM32_EEPROM_ENABLE) || defined(PROTOCOL_ARM_ATSAM) || defined(EEPROM_SIZE)
-  if (eeconfig_read_rgblight() != val) {
+    rgblight_check_config();
     eeprom_update_dword(EECONFIG_RGBLIGHT, val);
-  }
   #endif
 }
+
 void eeconfig_update_rgblight_default(void) {
   //dprintf("eeconfig_update_rgblight_default\n");
   rgblight_config.enable = 1;
@@ -148,6 +179,7 @@ void eeconfig_update_rgblight_default(void) {
   rgblight_config.speed = 0;
   eeconfig_update_rgblight(rgblight_config.raw);
 }
+
 void eeconfig_debug_rgblight(void) {
   dprintf("rgblight_config eprom\n");
   dprintf("rgblight_config.enable = %d\n", rgblight_config.enable);
@@ -159,6 +191,11 @@ void eeconfig_debug_rgblight(void) {
 }
 
 void rgblight_init(void) {
+  /* if already initialized, don't do it again.
+     If you must do it again, extern this and set to false, first.
+     This is a dirty, dirty hack until proper hooks can be added for keyboard startup. */
+  if (is_rgblight_initialized) { return; }
+
   debug_enable = 1; // Debug ON!
   dprintf("rgblight_init called.\n");
   dprintf("rgblight_init start!\n");
@@ -173,6 +210,8 @@ void rgblight_init(void) {
     eeconfig_update_rgblight_default();
     rgblight_config.raw = eeconfig_read_rgblight();
   }
+  rgblight_check_config();
+
   eeconfig_debug_rgblight(); // display current eeprom values
 
 #ifdef RGBLIGHT_USE_TIMER
@@ -182,6 +221,9 @@ void rgblight_init(void) {
   if (rgblight_config.enable) {
     rgblight_mode_noeeprom(rgblight_config.mode);
   }
+
+  is_rgblight_initialized = true;
+
 }
 
 void rgblight_update_dword(uint32_t dword) {

quantum/rgblight.h

@@ -146,6 +146,7 @@ extern const uint8_t RGBLED_RAINBOW_SWIRL_INTERVALS[3] PROGMEM;
 extern const uint8_t RGBLED_SNAKE_INTERVALS[3] PROGMEM;
 extern const uint8_t RGBLED_KNIGHT_INTERVALS[3] PROGMEM;
 extern const uint16_t RGBLED_RGBTEST_INTERVALS[1] PROGMEM;
+extern bool is_rgblight_initialized;
 
 typedef union {
   uint32_t raw;

tmk_core/chibios.mk

@@ -39,9 +39,13 @@ include $(STARTUP_MK)
 # HAL-OSAL files (optional).
 include $(CHIBIOS)/os/hal/hal.mk
 
-PLATFORM_MK = $(CHIBIOS)/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)/platform.mk
+ifeq ("$(PLATFORM_NAME)","")
+	PLATFORM_NAME = platform
+endif
+
+PLATFORM_MK = $(CHIBIOS)/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)/$(PLATFORM_NAME).mk
 ifeq ("$(wildcard $(PLATFORM_MK))","")
-PLATFORM_MK = $(CHIBIOS_CONTRIB)/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)/platform.mk
+PLATFORM_MK = $(CHIBIOS_CONTRIB)/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)/$(PLATFORM_NAME).mk
 endif
 include $(PLATFORM_MK)
 

util/docker_build.sh

@@ -39,11 +39,12 @@ if [ -n "$target" ]; then
 	else
 		echo "Error: target requires docker-machine to work on your platform" >&2
 		echo "See http://gw.tnode.com/docker/docker-machine-with-usb-support-on-windows-macos" >&2
+		echo "Consider flashing with QMK Toolbox (https://github.com/qmk/qmk_toolbox) instead" >&2
 		exit 3
 	fi
 fi
 dir=$(pwd -W 2>/dev/null) || dir=$PWD  # Use Windows path if on Windows
 
 # Run container and build firmware
-docker run --rm $usb_args -v "$dir":/qmk_firmware qmkfm/qmk_firmware \
+docker run --rm -it $usb_args -v "$dir":/qmk_firmware qmkfm/qmk_firmware \
 	make "$keyboard${keymap:+:$keymap}${target:+:$target}"

util/travis_compiled_push.sh

@@ -1,9 +1,6 @@
 #!/bin/bash
 
-TRAVIS_BRANCH="${TRAVIS_BRANCH:master}"
+source util/travis_push.sh
-TRAVIS_PULL_REQUEST="${TRAVIS_PULL_REQUEST:false}"
-TRAVIS_COMMIT_MESSAGE="${TRAVIS_COMMIT_MESSAGE:-none}"
-TRAVIS_COMMIT_RANGE="${TRAVIS_COMMIT_RANGE:-HEAD~1..HEAD}"
 
 set -o errexit -o nounset
 
@@ -12,17 +9,6 @@ echo "Using git hash ${rev}"
 
 if [[ "$TRAVIS_BRANCH" == "master" && "$TRAVIS_PULL_REQUEST" == "false" ]] ; then
 
-git config --global user.name "QMK Bot"
-git config --global user.email "[email protected]"
-
-openssl aes-256-cbc -K $encrypted_b0ee987fd0fc_key -iv $encrypted_b0ee987fd0fc_iv -in secrets.tar.enc -out secrets.tar -d
-tar xvf secrets.tar
-
-chmod 600 id_rsa_qmk_firmware
-chmod 600 id_rsa_qmk.fm
-eval `ssh-agent -s`
-ssh-add id_rsa_qmk_firmware
-
 # convert to unix line-endings
 git checkout master
 git diff --diff-filter=M --name-only -n 1 -z ${TRAVIS_COMMIT_RANGE} | xargs -0 dos2unix

util/travis_push.sh

@@ -5,13 +5,15 @@ TRAVIS_PULL_REQUEST="${TRAVIS_PULL_REQUEST:false}"
 TRAVIS_COMMIT_MESSAGE="${TRAVIS_COMMIT_MESSAGE:-none}"
 TRAVIS_COMMIT_RANGE="${TRAVIS_COMMIT_RANGE:-HEAD~1..HEAD}"
 
-git config --global user.name "QMK Bot"
+if [[ "$TRAVIS_BRANCH" == "master" && "$TRAVIS_PULL_REQUEST" == "false" ]] ; then
-git config --global user.email "[email protected]"
+	git config --global user.name "QMK Bot"
+	git config --global user.email "[email protected]"
 
-openssl aes-256-cbc -K $encrypted_b0ee987fd0fc_key -iv $encrypted_b0ee987fd0fc_iv -in secrets.tar.enc -out secrets.tar -d
+	openssl aes-256-cbc -K $encrypted_b0ee987fd0fc_key -iv $encrypted_b0ee987fd0fc_iv -in secrets.tar.enc -out secrets.tar -d
-tar xvf secrets.tar
+	tar xvf secrets.tar
 
-chmod 600 id_rsa_qmk_firmware
+	chmod 600 id_rsa_qmk_firmware
-chmod 600 id_rsa_qmk.fm
+	chmod 600 id_rsa_qmk.fm
-eval `ssh-agent -s`
+	eval `ssh-agent -s`
-ssh-add id_rsa_qmk_firmware
+	ssh-add id_rsa_qmk_firmware
+fi