Package org.jenkinsci.plugin.gitea

package org.jenkinsci.plugin.gitea

Jenkins SCM API implementation for Gitea

. The primary entry points for the implementation are:

• GiteaSCMSource - the SCMSource implementation
• GiteaSCMNavigator - the SCMNavigator implementation

These implementations are SCMTrait based and accept the traits for AbstractGitSCMSource as well as the Gitea specific traits:

• BranchDiscoveryTrait
• ForkPullRequestDiscoveryTrait
• OriginPullRequestDiscoveryTrait
• SSHCheckoutTrait
• WebhookRegistrationTrait

Extension plugins wanting to add Gitea-specific traits should target at least one of:

• GiteaSCMNavigatorContext for SCMNavigatorTraits
• GiteaSCMNavigatorRequest for SCMNavigatorTraits
• GiteaSCMSourceBuilder for SCMNavigatorTraits
• GiteaSCMSourceContext for SCMSourceTraits
• GiteaSCMSourceRequest for SCMSourceTraits
• GiteaSCMBuilder for SCMSourceTraits

Events from a Gitea server are propagated through the standard SCMEvent subsystem. Plugins wanting to listen for Gitea events and take custom actions based on the Gitea payloads should listen for the relevant AbstractGiteaSCMHeadEvent subclass. Adding support for new event types requires

1. implementing the required payload type (extending from GiteaEvent)
2. implementing the required SCMEvent subclass
3. providing a GiteaWebhookHandler extension to wire it all together

Related Packages

Package	Description
org.jenkinsci.plugin.gitea.authentication	The AuthenticationTokenSource implementations to map between Credentials API and the org.jenkinsci.plugin.gitea.client.api authentication support.
org.jenkinsci.plugin.gitea.credentials	Gitea specific Credentials interface and default implementation.
org.jenkinsci.plugin.gitea.servers	Jenkins UI for managing the list of Gitea servers.
org.jenkinsci.plugin.gitea.tasks

Class	Description
AbstractGiteaSCMHeadEvent<E extends GiteaEvent>	Base class for SCMHeadEvent from Gitea.
AbstractGiteaSCMSourceEvent<E extends GiteaEvent>	Base class for SCMHeadEvent from Gitea.
BranchDiscoveryTrait	A Discovery trait for Gitea that will discover branches on the repository.
BranchDiscoveryTrait.BranchSCMHeadAuthority	Trusts branches from the origin repository.
BranchDiscoveryTrait.BranchSCMHeadAuthority.DescriptorImpl	Out descriptor.
BranchDiscoveryTrait.DescriptorImpl	Our descriptor.
BranchDiscoveryTrait.ExcludeOriginPRBranchesSCMHeadFilter	Filter that excludes branches that are also filed as a pull request.
BranchDiscoveryTrait.OnlyOriginPRBranchesSCMHeadFilter	Filter that excludes branches that are not also filed as a pull request.
BranchDiscoveryTrait.OriginPRBranchesOrMainSCMHeadFilter	Filter that excludes branches that are not also filed as a pull request or the main branch.
BranchSCMHead	Our SCMHead for Gitea branches.
BranchSCMRevision	Our SCMRevision for BranchSCMHead.
ExcludeArchivedRepositoriesTrait	A Selection trait that will restrict the discovery of repositories that have been archived.
ExcludeArchivedRepositoriesTrait.DescriptorImpl	Exclude archived repositories filter
ForkPullRequestDiscoveryTrait	A Discovery trait for Gitea that will discover pull requests from forks of the repository.
ForkPullRequestDiscoveryTrait.DescriptorImpl	Our descriptor.
ForkPullRequestDiscoveryTrait.TrustContributors	An SCMHeadAuthority that trusts contributors to the repository.
ForkPullRequestDiscoveryTrait.TrustContributors.DescriptorImpl	Our descriptor.
ForkPullRequestDiscoveryTrait.TrustEveryone	An SCMHeadAuthority that trusts everyone.
ForkPullRequestDiscoveryTrait.TrustEveryone.DescriptorImpl	Our descriptor.
ForkPullRequestDiscoveryTrait.TrustNobody	An SCMHeadAuthority that trusts nothing.
ForkPullRequestDiscoveryTrait.TrustNobody.DescriptorImpl	Our descriptor.
GiteaAvatar	Metadata for the avatar of a Gitea Organization / user / repository.
GiteaBrowser	A GitRepositoryBrowser for Gitea.
GiteaBrowser.DescriptorImpl	Our descriptor.
GiteaCreateSCMEvent	A SCMHeadEvent for a GiteaCreateEvent.
GiteaCreateSCMEvent.HandlerImpl	Our handler.
GiteaDeleteSCMEvent	A SCMHeadEvent for a GiteaDeleteEvent.
GiteaDeleteSCMEvent.HandlerImpl	Our handler.
GiteaLink	Link to Gitea
GiteaNotifier	Notification of commit status information to Gitea.
GiteaNotifier.JobCheckOutListener
GiteaNotifier.JobCompletedListener	Sends notifications to Bitbucket on Run completed.
GiteaNotifier.JobScheduledListener	Listener to catch jobs being added to the build queue.
GiteaPullSCMEvent	A SCMHeadEvent for a GiteaPullRequestEvent.
GiteaPullSCMEvent.HandlerImpl	Our handler.
GiteaPushSCMEvent	A SCMHeadEvent for a GiteaPushEvent.
GiteaPushSCMEvent.HandlerImpl	Our handler.
GiteaReleaseNotifier
GiteaReleaseNotifier.JobCompletedListener
GiteaReleaseSCMEvent
GiteaReleaseSCMEvent.HandlerImpl
GiteaRepositorySCMEvent	A SCMHeadEvent for a GiteaPushEvent.
GiteaRepositorySCMEvent.HandlerImpl	Our handler.
GiteaSCMBuilder	Builds a GitSCM for GiteaSCMSource.
GiteaSCMFileSystem
GiteaSCMFileSystem.BuilderImpl
GiteaSCMNavigator
GiteaSCMNavigator.DescriptorImpl
GiteaSCMNavigatorContext
GiteaSCMNavigatorRequest
GiteaSCMSource
GiteaSCMSource.DescriptorImpl
GiteaSCMSourceBuilder
GiteaSCMSourceContext
GiteaSCMSourceRequest
GiteaWebhookAction
GiteaWebhookHandler<E extends jenkins.scm.api.SCMEvent<P>,P extends GiteaEvent>
GiteaWebhookListener
GiteaWebhookListener.GitSCMOnSaveNotifier
MergeWithGitSCMExtension	Deprecated. use MergeWithGitSCMExtension
Messages	Generated localization support class.
OriginPullRequestDiscoveryTrait	A Discovery trait for Gitea that will discover pull requests originating from a branch in the repository itself.
OriginPullRequestDiscoveryTrait.DescriptorImpl
OriginPullRequestDiscoveryTrait.OriginChangeRequestSCMHeadAuthority	A SCMHeadAuthority that trusts origin pull requests
OriginPullRequestDiscoveryTrait.OriginChangeRequestSCMHeadAuthority.DescriptorImpl	Our descriptor.
PullRequestSCMHead
PullRequestSCMRevision
ReleaseDiscoveryTrait
ReleaseDiscoveryTrait.DescriptorImpl
ReleaseSCMHead
ReleaseSCMHeadCategory	Category for SCMHead instances that implement ReleaseSCMHead.
ReleaseSCMRevision
SSHCheckoutTrait
SSHCheckoutTrait.DescriptorImpl
TagDiscoveryTrait	A Discovery trait for Gitea that will discover tags on the repository.
TagDiscoveryTrait.DescriptorImpl	Our descriptor.
TagDiscoveryTrait.TagSCMHeadAuthority	Trusts tags from the origin repository.
TagDiscoveryTrait.TagSCMHeadAuthority.DescriptorImpl	Out descriptor.
TagSCMHead	Our SCMHead for Gitea tags.
TagSCMRevision	Our SCMRevision for BranchSCMHead.
WebhookRegistration	Enumeration of the different webhook registration modes.
WebhookRegistrationTrait	A SCMSourceTrait for GiteaSCMSource that overrides the GiteaServers settings for webhook registration.
WebhookRegistrationTrait.DescriptorImpl	Our constructor.