Webhook question

[nanikjava]

Hello,

Been experimenting with doco-cd and was wondering is it possible for doco-cd to be triggered for other webhook event such as for example package.published, etc ?.

From experimenting noticed that it works correctly with push events only ?. Is that the case ?

Thanks

[kimdre]

That depends on the webhook payload. Doco-CD requires that certain fields be present in the JSON payload, see https://github.com/kimdre/doco-cd/blob/main/internal/webhook/payload.go#L8-L18

Since package.published has no relation to the actual source code, I believe it won't work.

[nanikjava]

Thanks @kimdre

The reason I'm asking this is for the following use case. If I'm using Github ghcr.io to push my container image from my Github workflow action the webhook will be called when push event are generated. This will not work because the new container image is still being build in the Github action.

Any idea on how to address this kind of scenario ?

Thanks

[kimdre]

You could use Github actions to trigger a webhook event from there when the image was pushed.

[nanikjava]

Good idea. Will do investigation on this.

Thanks.

[nanikjava]

Found a way to send push event manually from Github action

name: Send Dynamic Push Event Webhook

on:
  repository_dispatch:
    types: [docker_publish_done]

jobs:
  send-push-event:
    runs-on: ubuntu-latest
    steps:
      - name: Send push event to webhook (with HMAC SHA256 signature)
        env:
          WEBHOOK_URL: ${{ secrets.WEBHOOK_URL }}
          WEBHOOK_SECRET: ${{ secrets.WEBHOOK_SECRET }}
        run: |
          CLONE_URL="https://github.com/${GITHUB_REPOSITORY}.git"
          PAYLOAD=$(jq -n \
            --arg ref "${GITHUB_REF}" \
            --arg before "${GITHUB_SHA}" \
            --arg after "${GITHUB_SHA}" \
            --arg clone_url "$CLONE_URL" \
            --arg reponame "${GITHUB_REPOSITORY##*/}" \
            --arg repo_fullname "${GITHUB_REPOSITORY}" \
            --arg pusher_name "${GITHUB_ACTOR}" \
            --arg pusher_email "noreply@github.com" \
            '{
              ref: $ref,
              before: $before,
              after: $after,
              repository: {
                name: $reponame,
                full_name: $repo_fullname,
                clone_url: $clone_url
              },
              pusher: {
                name: $pusher_name,
                email: $pusher_email
              }
            }'
          )

          SIGNATURE="sha256=$(echo -n "$PAYLOAD" | openssl dgst -sha256 -hmac "$WEBHOOK_SECRET" | sed 's/^.* //')"

          curl -v -X POST "$WEBHOOK_URL" \
            -H "X-GitHub-Event: push" \
            -H "Content-Type: application/json" \
            -H "X-Hub-Signature-256: $SIGNATURE" \
            -d "$PAYLOAD"

in the main workflow action after docker push is complete and have the following step

      - name: Notify by repository dispatch
        env:
          GH_TOKEN: ${{ secrets.REPO_GITHUB_TOKEN }}
        run: |
          curl -X POST \
            -H "Authorization: Bearer $GH_TOKEN" \
            -H "Accept: application/vnd.github+json" \
            https://api.github.com/repos/${{ github.repository }}/dispatches \
            -d '{"event_type":"docker_publish_done"}'

this works perfectly.

[kimdre]

Cool, thanks for sharing your solution! :)