Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Shipwright Webhook Feed #261

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

adambkaplan
Copy link
Member

Changes

This community README update serves as an announcement that any community member can receive automated notifications of Shipwright activity through GitHub's webhook feed mechanism. For now, anyone can request access by emailing the project admins
([email protected]). Maintainers with org-wide write permission will then need to work with the requestor to obtain the desired endpoint, webhook secret, payload format, and types of events to receive. In the future, we can gather some of this information up front through a GitHub issue template (obviously not the secret - that should be exchanged through a proper private channel).

This was prompted by previous work I did to send GitHub issue and PR events to Fedora's GitHub2FedMsg bus [1]. I had set this up on behalf of Red Hat to sync data from GitHub to Red Hat's issue tracker. There is no compelling reason to restrict this sort of feed to just Red Hat; any community member who wants to track our project work in their own systems should be able to do so.

[1] https://github.com/fedora-infra/github2fedmsg

/kind documentation

Submitter Checklist

  • Includes tests if functionality changed/was added
  • Includes docs if changes are user-facing
  • Set a kind label on this PR
  • Release notes block has been filled in, or marked NONE

See the contributor guide
for details on coding conventions, github and prow interactions, and the code review process.

Release Notes

NONE

This community README update serves as an announcement that any
community member can receive automated notifications of Shipwright
activity through GitHub's webhook feed mechanism. For now, anyone can
request access by emailing the project admins
([email protected]). Maintainers with org-wide write
permission will then need to work with the requestor to obtain the
desired endpoint, webhook secret, payload format, and types of events
to receive. In the future, we can gather some of this information up
front through a GitHub issue template (obviously not the secret - that
should be exchanged through a proper private channel).

This was prompted by previous work I did to send GitHub issue and PR
events to Fedora's GitHub2FedMsg bus [1]. I had set this up on behalf
of Red Hat to sync data from GitHub to Red Hat's issue tracker. There
is no compelling reason to restrict this sort of feed to just Red Hat;
any community member who wants to track our project work in their own
systems should be able to do so.

[1] https://github.com/fedora-infra/github2fedmsg

Signed-off-by: Adam Kaplan <[email protected]>
@pull-request-size pull-request-size bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Feb 4, 2025
@openshift-ci openshift-ci bot added the kind/documentation Categorizes issue or PR as related to documentation. label Feb 4, 2025
Copy link

openshift-ci bot commented Feb 4, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from adambkaplan. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

1 participant