Configuration Reference
The nmk-badges plugin handles the configuration items listed in this page.
All of them are initiliazed with convenient default values, so that you don’t need to setup them for a default working behavior. You can anyway override them in your projet if you need to fine tune the plugin behavior. Some items are specifically designed to be extended by nmk projects and plugins.
Files
badgesTarget – target README.md file
Type |
Default value |
|---|---|
str |
${PROJECTDIR}/README.md |
Target README.md file where generated badges will be inserted
badgesStamp – badges stamp file
Type |
Default value |
|---|---|
str |
${outputDir}/.badges |
Stamp file to track the last time the ${badgesTarget} file was updated with generated badges.
Patterns
badgesBeginPattern – begin pattern
Type |
Default value |
|---|---|
str |
|
Begin pattern for the ${badgesTarget} file area to be updated with generated badges.
badgesEndPattern – end pattern
Type |
Default value |
|---|---|
str |
|
End pattern for the ${badgesTarget} file area to be updated with generated badges.
Badges
badges – badges definition
Type |
Default value |
|---|---|
List[Dict[str,str]] |
{} |
This configuration is a list of badges to be inserted in the ${badgesTarget} file.
Each item in the list is a dictionnary, expected to have the following keys:
alt: alternative descriptive text for the badgeimg: URL to badge generated imageurl: target URL for badge linkif: when set, the badge will be generated only if the provided condition is metunless: when set, the badge will be generated unless the provided condition is met
Note that badges conditions are handled the same way than task ones.