A GitHub Action to easily create an event on a Service Catalog server. This uses the Events API to post an event to the server.

Usage

    - uses: clearwind-ca/create-event@v1
      env:
        SERVICE_CATALOG_TOKEN: ${{ secrets.SERVICE_CATALOG_TOKEN }}
      with:
        catalog_url: "https://url-to-your-service-catalog.com"
        name: A test deployment
        type: Deployment
        source: GitHub Action

Required secrets

This secret must exist so that it can authenticate with the Service Catalog.

Name	Required	Value
SERVICE_CATALOG_TOKEN	Yes	A valid API token for your Service Catalog server

Inputs

Name	Required	Default	Value
event_file	No	/tmp/service-catalog-event.json	Path to the file

If event_file is set to a file, or the default file is present then the value of that file will be read, parsed as JSON and sent to the Service Catalog.

If the file is not present and no value is set then the following inputs will used.

Name	Required	Default	Value
name	Yes		The name of the event
start	No	Now	The start of the event in the format: YYYY-MM-DD:HH:MM:SSZ
end	No		The end of the event in the format: YYYY-MM-DD:HH:MM:SSZ
type	Yes		Type of the event as string, eg: Deployment, Migration
description	No		Text description of the event, markdown accepted.
external_id	No		An id external to the Service Catalog of the event
source	No		The source of the event
url	No		The URL of the event
active	No	True	If the event is active. Use false to make the event inactive.

Example file

{
    "name": "Test",
    "start": "2023-05-05T18:43:19.658Z",
    "type": "Test Event",
    "description": "This is a test event",
    "active": true
}