fix readme hook env variables
All checks were successful
ci/woodpecker/push/tests Pipeline was successful
All checks were successful
ci/woodpecker/push/tests Pipeline was successful
This commit is contained in:
parent
139863ac18
commit
961fc851cb
2 changed files with 31 additions and 23 deletions
|
@ -20,6 +20,7 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
- Verbose and Debug logging now have a space as a seperator between log level-name and log-level
|
- Verbose and Debug logging now have a space as a seperator between log level-name and log-level
|
||||||
|
- APIs now have an attribute with their name (for the hooks) - `api.api_name`
|
||||||
|
|
||||||
## [2.1.12] - 2022-07-25
|
## [2.1.12] - 2022-07-25
|
||||||
|
|
||||||
|
|
53
README.md
53
README.md
|
@ -249,9 +249,16 @@ Each of these hooks can be set with a specific flag:
|
||||||
|
|
||||||
#### Example:
|
#### Example:
|
||||||
|
|
||||||
`manga-dlp -u <some url> -c 1 --hook-post-manga <some command>`
|
```sh
|
||||||
|
manga-dlp -u <some url> -c 1 --hook-post-manga <some command>
|
||||||
|
|
||||||
`manga-dlp -u <some url> -c 1 --hook-post-manga "echo abc"`
|
# echo "abc" to stdout
|
||||||
|
manga-dlp -u <some url> -c 1 --hook-post-manga "echo abc"
|
||||||
|
|
||||||
|
# echo the manga name to stdout
|
||||||
|
|
||||||
|
manga-dlp -u <some url> -c 1 --hook-post-manga "echo ${MDLP_MANGA_TITLE}"
|
||||||
|
```
|
||||||
|
|
||||||
#### Env Variables
|
#### Env Variables
|
||||||
|
|
||||||
|
@ -260,33 +267,33 @@ All available env variables are:
|
||||||
|
|
||||||
**General:**
|
**General:**
|
||||||
|
|
||||||
- `HOOK_TYPE`
|
- `MDLP_HOOK_TYPE`
|
||||||
- `STATUS`
|
- `MDLP_STATUS`
|
||||||
- `REASON`
|
- `MDLP_REASON`
|
||||||
|
|
||||||
**Manga hooks:**
|
**Manga hooks:**
|
||||||
|
|
||||||
- `API`
|
- `MDLP_API`
|
||||||
- `MANGA_URL_UUID`
|
- `MDLP_MANGA_URL_UUID`
|
||||||
- `MANGA_UUID`
|
- `MDLP_MANGA_UUID`
|
||||||
- `MANGA_TITLE`
|
- `MDLP_MANGA_TITLE`
|
||||||
- `LANGUAGE`
|
- `MDLP_LANGUAGE`
|
||||||
- `TOTAL_CHAPTERS`
|
- `MDLP_TOTAL_CHAPTERS`
|
||||||
- `CHAPTERS_TO_DOWNLOAD`
|
- `MDLP_CHAPTERS_TO_DOWNLOAD`
|
||||||
- `FILE_FORMAT`
|
- `MDLP_FILE_FORMAT`
|
||||||
- `FORCEVOL`
|
- `MDLP_FORCEVOL`
|
||||||
- `DOWNLOAD_PATH`
|
- `MDLP_DOWNLOAD_PATH`
|
||||||
- `MANGA_PATH`
|
- `MDLP_MANGA_PATH`
|
||||||
|
|
||||||
**Chapter hooks (extends Manga hooks env variables):**
|
**Chapter hooks (extends Manga hooks env variables):**
|
||||||
|
|
||||||
- `CHAPTER_FILENAME`
|
- `MDLP_CHAPTER_FILENAME`
|
||||||
- `CHAPTER_PATH`
|
- `MDLP_CHAPTER_PATH`
|
||||||
- `CHAPTER_ARCHIVE_PATH`
|
- `MDLP_CHAPTER_ARCHIVE_PATH`
|
||||||
- `CHAPTER_UUID`
|
- `MDLP_CHAPTER_UUID`
|
||||||
- `CHAPTER_VOLUME`
|
- `MDLP_CHAPTER_VOLUME`
|
||||||
- `CHAPTER_NUMBER`
|
- `MDLP_CHAPTER_NUMBER`
|
||||||
- `CHAPTER_NAME`
|
- `MDLP_CHAPTER_NAME`
|
||||||
|
|
||||||
## Contribution / Bugs
|
## Contribution / Bugs
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue