added notes about github workflow env variables

Author: sannae

.github/workflows/ci.yaml

@@ -32,6 +32,7 @@ jobs:
       - run: mkdocs gh-deploy --force
 
       # Run language tracker
-      - env:
+      - name: Run language tracker
+        env:
           ACCESS_TOKEN: "${{ secrets.ACCESS_TOKEN }}"
         run: python3 ${GITHUB_WORKSPACE}/scripts/lang-tracker.py

docs/dev/github.md

@@ -94,6 +94,34 @@ To use the runner, add in your `.github/workflows/WORFLOW_NAME.yml` file:
 runs-on: self-hosted
 ```
 
+### Define a workflow
+
+#### Generic env variables
+
+* `${GITHUB_WORKSPACE}`: the project root folder (i.e. the one containing the `.github\workflows` subfolder)
+* `${{ github.event.repository.name }}`: the project name, in our case `the-notebook`
+* `${{ github.repository_owner }}`: the repository owner, in our case `sannae` (i.e. myself!)
+
+
+#### Use the secrets as env variables
+
+Once you've defined a GitHub Secret, you can access it in your workflow as an environment variable from the step/job/workflow scope:
+
+```yaml
+      - name: Your step name
+
+        # Define an environment variable ACCESS_TOKEN 
+        # whose value is read from the GitHub Secret with the same name
+        env:
+          ACCESS_TOKEN: "${{ secrets.ACCESS_TOKEN }}"
+        run: python3 ${GITHUB_WORKSPACE}/scripts/lang-tracker.py
+```
+
+In the example above, the script `lang-tracker.py` is able to see the environment variable with the `os.environ[]` function:
+
+```python
+g = Github(os.environ['ACCESS_TOKEN'])
+```
 
 
 ## Github API

docs/index.md

@@ -19,3 +19,7 @@ The website configuration (including navigation, custom themes, extensions, plug
 Publishing is made on [GitHub Pages](https://pages.github.com/) and is handled by [GitHub Actions](https://github.com/features/actions) with a [cloud-hosted runner](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners). 
 
 The workflow YAML file is available [here](https://github.com/sannae/the-notebook/blob/main/.github/workflows/ci.yaml) and is triggered by any push on the `main` branch.
+
+## Similar brilliant projects
+
+* [:material-github: javierobcn/Notas](https://www.javieranto.com/)

mkdocs.yml

@@ -1,4 +1,8 @@
+# Project information
 site_name: The Notebook
+site_url: https://sannae.github.io/the-notebook
+site_author: sannae
+site_description: Welcome to my online knowledge base!
 
 # Nav bar
 nav:
@@ -36,11 +40,19 @@ repo_url: https://github.com/sannae/the-notebook
 # Graphics
 theme:
   name: material
+  custom_dir: overrides
   favicon: images/logo.png
+  language: en
+
+  # Themes
+  font:
+    text: Roboto
+    code: Roboto Mono
+
+  # Icons
   icon:
     repo: fontawesome/brands/git-alt
     logo: material/library
-  # custom_dir: material
 
   # Color theme
   palette:

scripts/lang-tracker.py

@@ -15,8 +15,6 @@ def get_secret(setting, secrets=secrets):
 g = Github(get_secret('ACCESS_TOKEN'))
 """
 
-print(os.environ['ACCESS_TOKEN'])
-
 g = Github(os.environ['ACCESS_TOKEN'])
 
 lang_dict = dict()
@@ -36,3 +34,6 @@ def get_secret(setting, secrets=secrets):
 
 # output
 print(total_langs)
+
+# Write record on SQLite database
+