https://github.com/keptn/gh-action-send-event
GH Action to send an event to a Keptn installation
https://github.com/keptn/gh-action-send-event
Last synced: 10 months ago
JSON representation
GH Action to send an event to a Keptn installation
- Host: GitHub
- URL: https://github.com/keptn/gh-action-send-event
- Owner: keptn
- Archived: true
- Created: 2021-04-13T11:14:51.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2022-02-08T20:19:16.000Z (over 4 years ago)
- Last Synced: 2025-05-12T19:15:24.299Z (about 1 year ago)
- Language: JavaScript
- Size: 39.1 KB
- Stars: 3
- Watchers: 11
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# gh-action-send-event
GH Action to send an event to a Keptn deployment
## Inputs
| Name | Mandatory | Format | Description |
|--|--|--|--|
| keptnApiUrl | yes | url | URL pointing to the keptn events API (Example: http://example.nip.io/api/v1/event ) |
| keptnApiToken | yes | string | API Token to be used for sending the event |
| event | yes | JSON | Event to be sent (See: [Keptn Cloud Events](https://www.google.com/search?q=keptn%20spec)) |
## Outputs
| Name | Description |
|--|--|
| keptnContext | The Keptn context bound to the sent event |
## Example Usage
The following example uses this Github Action to send an event which triggers a sequence called `delivery`
whenever something is pushed to the repository.
```yaml
name: Keptn Send Event
on: [push]
jobs:
send_keptn_event:
runs-on: ubuntu-latest
name: Sends Keptn Events
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Send Keptn Event
id: send-keptn-event
uses: keptn/gh-action-send-event@main
with:
keptnApiUrl: ${{ secrets.KEPTN_API_URL }}
keptnApiToken: ${{ secrets.KEPTN_API_TOKEN }}
event: |
{
"data": {
"configurationChange": {
"values": {
"image": "docker.io/mongo:4.2.2"
}
},
"deployment": {
"deploymentstrategy": "direct"
},
"message": "",
"project": "sockshop2",
"result": "",
"service": "carts-db",
"stage": "dev",
"status": ""
},
"source": "gh",
"specversion": "1.0",
"type": "sh.keptn.event.dev.delivery.triggered",
"shkeptnspecversion": "0.2.1"
}
- name: Print the Keptn Context
run: echo "The keptn context is ${{ steps.send-keptn-event.outputs.keptnContext }}"
```
*Note that the fields `shkeptncontext`, `time` and `id` in the event to be sent are omitted **on purpose** because these will be generated automatically
by the API endpoint of Keptn.*