1
0
Fork 0
ynh-apps_tools/README-generator
Tagada f3a229b85f Remove link to the old documentation
Packagers should include those in the package, as ADMIN.md...
2023-09-28 16:51:47 +02:00
..
templates Remove link to the old documentation 2023-09-28 16:51:47 +02:00
__init__.py Add draft for autoreadme webhook service 2021-05-21 18:14:58 +02:00
make_readme.py Propagate the json/yml -> toml change to README generator 2023-01-20 00:02:59 +01:00
nginx.conf Use /github as endpoint 2021-05-21 20:17:02 +02:00
README.md Misc fixes 2021-05-21 20:12:00 +02:00
requirements.txt autoreadme: add toml to requirements.txt 2023-01-11 10:05:00 +01:00
webhook.py Homogenize bot's name/email b/w author/committer 2021-10-26 23:00:46 +02:00
webhook.service Misc fixes 2021-05-21 20:12:00 +02: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