README.md

Logflare Log Action

GitHub Action to create a log in a Logflare source

Usage

Before using the action, you need to create two secrets in your repository settings:

1. LOGFLARE_API_KEY - your Logflare API Key, find it on your Logflare Dashboard
2. LOGFLARE_SOURCE_ID - ID of one of your surces listed on your Logflare Dashboard

Example: Log every new release (example for github.event data)

name: Log new release
on:
  release:
    types: [published]

jobs:
  log:
    runs-on: ubuntu-latest
    steps:
      - uses: logflare/action@v1
        id: stats
        with:
          api_key: ${{ secrets.LOGFLARE_API_KEY }}
          source_id: ${{ secrets.LOGFLARE_SOURCE_ID }}
          message: "new release: ${{ github.event.release.html_url }}"
          metadata: |
            {
              "version": "${{ github.event.release.tag_name }}"
            }

Debugging

To see additional debug logs, create a secret with the name: ACTIONS_STEP_DEBUG and value true.

Contributing

See CONTRIBUTING.md

License

ISC