1
0
Fork 0
ynh-apps_tools/readme_generator
2024-03-08 04:16:36 +01:00
..
templates fixes eventual double line break after description & demo link between rafters 2024-03-07 23:30:46 +01:00
__init__.py Rename README-generator -> readme_generator because python tools hate caps… 2024-02-15 15:03:31 +01:00
make_readme.py feat(readme_generator): don't hardcode the list of languages, extract it from the README templates 2024-03-08 04:16:36 +01:00
nginx.conf Rename README-generator -> readme_generator because python tools hate caps… 2024-02-15 15:03:31 +01:00
README.md smol fixes 2024-03-07 02:47:30 +01:00
requirements.txt Rename README-generator -> readme_generator because python tools hate caps… 2024-02-15 15:03:31 +01:00
webhook.py Rename README-generator -> readme_generator because python tools hate caps… 2024-02-15 15:03:31 +01:00
webhook.service Rename README-generator -> readme_generator because python tools hate caps… 2024-02-15 15:03:31 +01:00

Auto-README generation

Initial install

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Use on a single app

source venv/bin/activate
./make_readme.py /path/to/app

Then the README.md in the app folder will be updated

Launch webhook service for auto update

Configure the webhook on github

Also need to allow the bot to push on all repos

Configure nginx to reverse proxy on port 8123 (or whichever port you set in the systemd config)

echo "github_webhook_secret" > github_webhook_secret
echo "the_bot_login" > login
echo "the_bot_token" > token

Add the webhook.service to systemd config, then start it:

systemctl start the_webhook_service