Update README
- update input and output examples - add license text
This commit is contained in:
parent
182f21944b
commit
63b77842cf
1 changed files with 21 additions and 5 deletions
26
README.md
26
README.md
|
@ -6,6 +6,21 @@ this can be used to trigger registry-image or docker-image builds when security
|
||||||
|
|
||||||
The source code for the resource type is available at https://git.dittberner.info/jan/concourse-dsa-resource
|
The source code for the resource type is available at https://git.dittberner.info/jan/concourse-dsa-resource
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
To use the resource type in your own Concourse pipeline you will have to define the resource type and a resource:
|
To use the resource type in your own Concourse pipeline you will have to define the resource type and a resource:
|
||||||
|
@ -50,11 +65,11 @@ shortened and pretty-printed example output looks like this:
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"date": "2023-01-18",
|
"date": "2023-01-18",
|
||||||
"title": "DSA-5322 firefox-esr"
|
"title": "DSA-5322"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"date": "2023-01-19",
|
"date": "2023-01-19",
|
||||||
"title": "DSA-5323 libitext5-java"
|
"title": "DSA-5323"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
```
|
```
|
||||||
|
@ -72,7 +87,7 @@ metadata. If the version exists. The following input example returns the output
|
||||||
"params": {},
|
"params": {},
|
||||||
"version": {
|
"version": {
|
||||||
"date": "2023-01-18",
|
"date": "2023-01-18",
|
||||||
"title": "DSA-5322 firefox-esr"
|
"title": "DSA-5322"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
@ -83,11 +98,12 @@ metadata. If the version exists. The following input example returns the output
|
||||||
{
|
{
|
||||||
"version": {
|
"version": {
|
||||||
"date": "2023-01-18",
|
"date": "2023-01-18",
|
||||||
"title": "DSA-5322 firefox-esr"
|
"dsa": "DSA-5322"
|
||||||
},
|
},
|
||||||
"metadata": {
|
"metadata": {
|
||||||
"link": "https://www.debian.org/security/2023/dsa-5322",
|
"link": "https://www.debian.org/security/2023/dsa-5322",
|
||||||
"description": "security update"
|
"package": "firefox-esr",
|
||||||
|
"description": "Multiple security issues have been found in the Mozilla Firefox web\nbrowser, which could potentially result in the execution of arbitrary\ncode, information disclosure or spoofing."
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
Loading…
Reference in a new issue