Verified Commit 5b4b2ac3 authored by Luc Didry's avatar Luc Didry
Browse files

Add how-to-use instructions in README

parent 422f15bf
Pipeline #94513 passed with stage
in 14 seconds
......@@ -4,7 +4,29 @@ This software is used for automatically tooting from Gitlab CI when creating a n
## How to use?
TODO: add instructions
First, get credentials for your app with the [register-app](https://framagit.org/fiat-tux/hat-softwares/mastodon/register-app) script.
With those credentials, in the CI settings of your project, create the following protected variables:
- `CLIENT_ID`
- `CLIENT_SECRET`
- `ACCESS_TOKEN`
- and create a `HOST` protected variable, containing the hostname of your Mastodon instance.
Then protect all your tags in the repository settings by creating a `*` wildcard.
Finally, add this to your `.gitlab-ci.yml`:
```
pouet-it:
image: hatsoftwares/pouet-it-from-ci:latest
script:
- cd /opt/pouet-it-from-ci
- export MESSAGE="Je viens de sortir une nouvelle version de ${CI_PROJECT_NAME} !\n${CI_PROJECT_URL}/tags/${CI_COMMIT_TAG}"
- carton exec ./pouet-it-from-ci.pl
only:
- tags
```
And that should be all.
## License
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment