search

veecode-platform / platform-backstage-plugins

Apache License 2.0
10 stars 3 forks source link

Configure Webhooks for Automatic Catalog Updates #21

Closed caiolombello closed 2 weeks ago

caiolombello commented 2 weeks ago

This sub-issue is related to the main issue #20 (Implement GitLab Discovery for Automated Catalog Management).

Objective: Configure GitLab Webhooks to automatically update the Backstage catalog whenever changes occur in GitLab repositories. This ensures that the catalog remains up-to-date with the most current state of the projects without the need for manual updates or static locations.

Reference:

Tasks:

  1. Set Up Webhooks in GitLab:

    • Configure Webhooks for the relevant GitLab repositories to listen for push events.
    • Follow the steps outlined in the GitLab Webhooks Documentation to set up the Webhooks correctly.

  2. Integrate Webhooks with Backstage:

    • Configure Backstage to ingest data from GitLab based on the Webhook events. Ensure that the Backstage entity provider is correctly set to handle the incoming Webhook events and update the catalog accordingly.
    • Reference the Backstage documentation for additional configuration details: GitLab Discovery Integration.

  3. Test the Integration:

    • Perform tests to validate that Webhook events from GitLab trigger the expected catalog updates in Backstage.
    • Ensure that the catalog updates are consistent with the changes in GitLab repositories and troubleshoot any issues that arise during testing.