Skip to content

fix wiki workflow #3008

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LKuemmel merged 1 commit into from
Dec 4, 2025
Merged

fix wiki workflow #3008

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions .github/workflows/publish_docs_to_wiki.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ on:
- master # This can be changed to any branch of your preference

env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # GitHub token for authentication
USER_NAME: LKuemmel # Enter the username of your (bot) account
USER_EMAIL: lena.kuemmel@openwb.de # Enter the e-mail of your (bot) account
WIKI_TOKEN: ${{ secrets.WIKI_ACTION_TOKEN }} # Personal Access Token with repo scope
USER_NAME: "GitHub Actions" # Enter the username of your (bot) account
USER_EMAIL: "actions@github.com" # Enter the e-mail of your (bot) account
OWNER: ${{ github.event.repository.owner.name }} # This is the repository owner
REPOSITORY_NAME: ${{ github.event.repository.name }} # This is the repository name

Expand All @@ -31,15 +31,15 @@ jobs:
mkdir tmp_wiki
cd tmp_wiki
git init
git config user.name "GitHub Actions"
git config user.email "actions@github.com"
git pull https://$GITHUB_TOKEN@github.com/$OWNER/$REPOSITORY_NAME.wiki.git
git pull https://$WIKI_TOKEN@github.com/$OWNER/$REPOSITORY_NAME.wiki.git
# 4. Synchronize differences between `docs` & `tmp_wiki`
# 5. Push new Wiki content
- name: Push content to wiki
run: |
rsync -av --delete docs/ tmp_wiki/ --exclude .git
cd tmp_wiki
git config user.name "$USER_NAME"
git config user.email "$USER_EMAIL"
git add .
git commit -m "Update Wiki content"
git push -f --set-upstream https://$GITHUB_TOKEN@github.com/$OWNER/$REPOSITORY_NAME.wiki.git master
git commit -m "Update Wiki content" || echo "No changes to commit"
git push -f --set-upstream https://$WIKI_TOKEN@github.com/$OWNER/$REPOSITORY_NAME.wiki.git master
2 changes: 1 addition & 1 deletion docs/Neues Modul programmieren.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ _Bei Fragen programmiert Ihr das SoC-Modul vorerst, wie Ihr es versteht, und ers
Die Klasse `UpdateConfig` verwaltet automatische Migrationen bei Breaking Changes und neuen Einstellungen. Das System funktioniert folgendermaßen:
- Für jede notwendige Anpassung wird eine nummerierte Upgrade-Funktion erstellt
- Beim Systemstart werden alle noch nicht ausgeführten Upgrade-Funktionen automatisch aufgerufen
- Die Nummern der bereits ausgeführten Funktionen werden persistent gespeichert, um mehrfache Ausführung zu verhindern. Der aktuelle Migrations-Status wird im MQTT-Topic `openWB/system/datastore_version` veröffentlicht
- Die Nummern der bereits ausgeführten Funktionen werden persistent gespeichert, um mehrfache Ausführung zu verhindern. Der aktuelle Migrations-Status wird im MQTT-Topic `openWB/system/datastore_version` veröffentlicht.

Alle Upgrade-Funktionen folgen einem einheitlichen Schema:
```python
Expand Down