Feat/code embedder (#1)

* refactor: replace update-readme script with code embedder action

* docs: Apply Code Embedder

* feat: add code embedder workflow for README updates

* Update README for Git configuration sections

* Rename job from code_embedder to code-embedder

* Update comment for clarity in .gitconfig.example

* docs: Apply Code Embedder

* Update paths in code-embedder.yml workflow

* Revert "Update comment for clarity in .gitconfig.example"

This reverts commit e7efb68.

* docs: Apply Code Embedder

* Revert "feat: add code embedder workflow for README updates"

This reverts commit da6bcfe.

* fix: correct paths in update-readme.yml workflow

---------

Co-authored-by: Anton Staroverov <5911853+73071319+tonystar@users.noreply.github.com>
Co-authored-by: github-actions <github-actions@github.com>

Author: 3 people

.github/workflows/update-readme.yml

@@ -3,29 +3,20 @@ name: Update README with Config Files
 on:
   push:
     paths:
+      - 'README.md'
       - '.gitconfig.example'
       - '.gitconfig-github'
       - '.gitconfig-gitlab'
       - '.github/workflows/update-readme.yml'
-      - 'scripts/update-readme.py'
 
 jobs:
-  update-readme:
+  code-embedder:
     runs-on: ubuntu-latest
     permissions:
       contents: write
     steps:
       - uses: actions/checkout@v4
 
-      - name: Update README with config file contents
-        run: python3 scripts/update-readme.py
-      
-      - name: Commit changes
-        run: |
-          git config user.name "github-actions[bot]"
-          git config user.email "github-actions[bot]@users.noreply.github.com"
-          if ! git diff --quiet HEAD; then
-            git add README.md
-            git commit -m "docs: update README with config file contents"
-            git push
-          fi
+      - uses: kvankova/code-embedder@v1.1.3
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -22,11 +22,9 @@ You'll need the following configuration files. Replace all `PLACE_HOLDER` values
 
 <!-- _The most up-to-date config version is now here: https://github.com/anydigital/git-commit-email-privacy_ -->
 
-### `.gitconfig` (Global Git Configuration)
+### `.gitconfig`
 
-<!-- GITCONFIG_EXAMPLE_START -->
-
-```ini
+```ini:.gitconfig.example
 # ====================================================================
 # Global Git Configuration
 #
@@ -55,15 +53,12 @@ You'll need the following configuration files. Replace all `PLACE_HOLDER` values
 
 [includeIf "hasconfig:remote.*.url:**/*gitlab.com/**"]
     path = .gitconfig-gitlab
-```
-
-<!-- GITCONFIG_EXAMPLE_END -->
 
-### `.gitconfig-github` (GitHub-Specific Configuration)
+```
 
-<!-- GITCONFIG_GITHUB_START -->
+### `.gitconfig-github`
 
-```ini
+```ini:.gitconfig-github
 # ====================================================================
 # GitHub-specific Git configuration
 #
@@ -74,15 +69,12 @@ You'll need the following configuration files. Replace all `PLACE_HOLDER` values
 
 [user]
     email = YOUR_GITHUB_ID+USERNAME@users.noreply.github.com
-```
 
-<!-- GITCONFIG_GITHUB_END -->
-
-### `.gitconfig-gitlab` (GitLab-Specific Configuration)
+```
 
-<!-- GITCONFIG_GITLAB_START -->
+### `.gitconfig-gitlab`
 
-```ini
+```ini:.gitconfig-gitlab
 # ====================================================================
 # GitLab-specific Git configuration
 #
@@ -93,9 +85,8 @@ You'll need the following configuration files. Replace all `PLACE_HOLDER` values
 
 [user]
     email = YOUR_GITLAB_ID-USERNAME@users.noreply.gitlab.com
-```
 
-<!-- GITCONFIG_GITLAB_END -->
+```
 
 ## How to Verify