From da49d58882703fe3bc695d1f47aeb9befc9b01ff Mon Sep 17 00:00:00 2001 From: Maximilian Wolff Date: Fri, 8 May 2020 23:58:28 +0200 Subject: [PATCH] [wakatime] Make doc clearly state not to store your api key in the layer config --- layers/+web-services/wakatime/README.org | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/layers/+web-services/wakatime/README.org b/layers/+web-services/wakatime/README.org index 5903cea0c..08a53b890 100644 --- a/layers/+web-services/wakatime/README.org +++ b/layers/+web-services/wakatime/README.org @@ -10,6 +10,7 @@ - [[#install][Install]] - [[#wakatime-program][Wakatime Program]] - [[#layer][Layer]] + - [[#note-about-api-key-and-bug-submission][Note about api key and bug submission]] - [[#api-keys][API Keys]] - [[#note-to-venv-workon-users][Note to =venv-workon= users:]] @@ -63,7 +64,18 @@ Example: #+END_SRC *** Note about api key and bug submission -If you use the built in spacemace bug sumission tool it will include the snippit of code above, including your api key, don't forget to remove it before submitting. +If you use the built-in Spacemacs bug submission tool it will include +all of your layer configs including your secret api key. +Please remove it before submitting. + +Even better don't store your key directly in the layer config. +Instead put the following code in your user-config which is set after your layer config: + +#+BEGIN_SRC emacs-lisp + (setq wakatime-api-key "your-api-key") +#+END_SRC + +Everything you set there won't appear in the bug submitting tool. ** API Keys After this go to your wakatime account and have your API key handy