Skip to main content

Notifikacije

Notify was built primarily to use with Slack's Incoming webhooks, but will also deliver a simple payload to any endpoint. This is currently only active for the npm publish command.

Korišćenje

Na primer sa HipChat, Stride i Google Hangouts Chat hook:

Verdaccio supports any API, feel free to add more examples.

Jedinstvena notifikacija

notify:
method: POST
headers: [{'Content-Type': 'application/json'}]
endpoint: https://usagge.hipchat.com/v2/room/3729485/notification?auth_token=mySecretToken
content: '{"color":"green","message":"New package published: * {{ name }}*","notify":true,"message_format":"text"}'

Višestruka notifikacija

notify:
'example-google-chat':
method: POST
headers: [{'Content-Type': 'application/json'}]
endpoint: https://chat.googleapis.com/v1/spaces/AAAAB_TcJYs/messages?key=myKey&token=myToken
content: '{"text":"New package published: `{{ name }}{{#each versions}} v{{version}}{{/each}}`"}'
'example-hipchat':
method: POST
headers: [{'Content-Type': 'application/json'}]
endpoint: https://usagge.hipchat.com/v2/room/3729485/notification?auth_token=mySecretToken
content: '{"color":"green","message":"New package published: * {{ name }}*","notify":true,"message_format":"text"}'
'example-stride':
method: POST
headers: [{'Content-Type': 'application/json'}, {'authorization': 'Bearer secretToken'}]
endpoint: https://api.atlassian.com/site/{cloudId}/conversation/{conversationId}/message
content: '{"body": {"version": 1,"type": "doc","content": [{"type": "paragraph","content": [{"type": "text","text": "New package published: * {{ name }}* Publisher name: * {{ publisher.name }}"}]}]}}'

Templat

Koristimo Handlebars kao main template engine.

Primeri za formate

# iterate all versions
{{ name }}{{#each versions}} v{{version}}{{/each}}

# publisher and `dist-tag` package published
{{ publisher.name }} has published {{ publishedPackage }}

Svojstva (Properties)

Lista svojstava kojima se može pristupiti preko templata

  • Metadata
  • Publisher (onaj koji publikuje)
  • Package Published (package@1.0.0)

Metadata

Package metadata za koje templat ima pristup

{
"_id": "@test/pkg1",
"name": "@test/pkg1",
"description": "",
"dist-tags": {
"beta": "1.0.54"
},
"versions": {
"1.0.54": {
"name": "@test/pkg1",
"version": "1.0.54",
"description": "some description",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": {
"name": "Author Name",
"email": "author@domain.com"
},
"license": "MIT",
"dependencies": {
"webpack": "4.12.0"
},
"readmeFilename": "README.md",
"_id": "@ test/pkg1@1.0.54",
"_npmVersion": "6.1.0",
"_nodeVersion": "9.9.0",
"_npmUser": {},
"dist": {
"integrity": "sha512-JlXWpLtMUBAqvVZBvH7UVLhXkGE1ctmXbDjbH/l0zMuG7wVzQ7GshTYvD/b5C+G2vOL2oiIS1RtayA/kKkTwKw==",
"shasum": "29c55c52c1e76e966e706165e5b9f22e32aa9f22",
"tarball": "http://localhost:4873/@test/pkg1/-/@test/pkg1-1.0.54.tgz"
}
}
},
"readme": "# test",
"_attachments": {
"@test/pkg1-1.0.54.tgz": {
"content_type": "application/octet-stream",
"data": "H4sIAAAAAAAAE+y9Z5PjyJIgOJ ...",
"length": 33112
}
},
"time": {}
}

Publisher

Možete pristupiti package publisher infomacijama u content u okviru webhook koristeći publisher objekat.

Pogledajte primer za publisher object type:

{
name: string,
groups: string[],
real_groups: string[]
}

Primer:

notify:
method: POST
headers: [{'Content-Type': 'application/json'}]
endpoint: https://usagge.hipchat.com/v2/room/3729485/notification?auth_token=mySecretToken
content: '{"color":"green","message":"New package published: * {{ name }}*. Publisher name: * {{ publisher.name }} *.","notify":true,"message_format":"text"}'

Napomena: Nije moguće dobiti publisher information ako package.json fajl već ima publisher svojstvo.

Package Published

Možete pristupiti opciji package is being published pomoću ključne reči {{publishedPackage}} na sledeći način.

{{ publisher.name }} has published {{ publishedPackage }}

Configuration

SvojstvoTipPotrebnoPodrškaPodrazumevanoOpis
methodstringNopotpunaHTTP verb
packagePatternstringNopotpunaPokreni ovu notifikaciju ako se ime paketa podudara sa regularnim izrazom (regular expression)
packagePatternFlagsstringNopotpunaBilo koja zastavica (flags) koja će se koristiti sa regular expression
zaglavlja (headers)array/objectDapotpunaAko endpoint zahteva specific headers, podesite ih ovde kao array of key: value objects.
endpointstringDapotpunapodesite URL endpoint za ovaj poziv
contentstringDapotpunabilo koji Handlebar expressions