Algolia key in environment variable (#2056)

Author: CharlesDuboisSAP

.github/workflows/release.yml

@@ -29,6 +29,7 @@ jobs:
         env:
           USE_SSH: true
           GIT_USER: gh-actions
+          ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }}
         run: |
           git config --global user.email "[email protected]"
           git config --global user.name "gh-actions"

CONTRIBUTING.md

@@ -9,6 +9,8 @@
 
 ## Hosting the Documentation Locally
 
+- _Optional: Create a `.env` file and write `ALGOLIA_API_KEY='<insert_key_here>'`._
+  _The key can be found in the team KeePassXC._
 - Run `npm install`
 - Run `npm start`
 - The SAP Cloud SDK documentation portal should open in a new browser window

docusaurus.config.js

@@ -1,4 +1,5 @@
 const { ProvidePlugin } = require('webpack');
+import 'dotenv/config';
 
 // We have to polyfill some Node APIs because Docusaurus migrated to Webpack 5
 // This is mainly required because of remark related modules which don't load otherwise
@@ -37,7 +38,7 @@ module.exports = {
       darkTheme: require('prism-react-renderer').themes.dracula
     },
     algolia: {
-      apiKey: '441c57554e5a0ca9338cc9f047fb10c8',
+      apiKey: process.env.ALGOLIA_API_KEY || 'fake_key',
       indexName: 'sap_cloud-sdk',
       appId: 'E4A268JVO0',
       algoliaOptions: {} // Optional, if provided by Algolia

package-lock.json

@@ -24,6 +24,7 @@
     "@docusaurus/theme-common": "^3.2.1",
     "buffer": "^6.0.3",
     "clsx": "^2.1.1",
+    "dotenv": "^16.4.7",
     "events": "^3.3.0",
     "prism-react-renderer": "^2.4.1",
     "react": "^18.3.0",