This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 92a4b7700d3b CAMEL-22961 - Deprecated Github component (#21268)
92a4b7700d3b is described below
commit 92a4b7700d3ba8cd8ec4a484f418ec8a8d939b4b
Author: Andrea Cosentino <[email protected]>
AuthorDate: Thu Feb 5 16:46:48 2026 +0100
CAMEL-22961 - Deprecated Github component (#21268)
Signed-off-by: Andrea Cosentino <[email protected]>
---
.../resources/org/apache/camel/catalog/components/github.json | 2 +-
.../META-INF/org/apache/camel/component/github/github.json | 2 +-
components/camel-github/src/main/docs/github-component.adoc | 11 +++++++++--
.../org/apache/camel/component/github/GitHubComponent.java | 3 +++
.../org/apache/camel/component/github/GitHubEndpoint.java | 3 +++
.../apache/camel/builder/endpoint/StaticEndpointBuilders.java | 2 ++
.../builder/endpoint/dsl/GitHubEndpointBuilderFactory.java | 3 +++
7 files changed, 22 insertions(+), 4 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/github.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/github.json
index 5edd3642a0ac..ef963344536f 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/github.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/github.json
@@ -4,7 +4,7 @@
"name": "github",
"title": "GitHub",
"description": "Interact with the GitHub API.",
- "deprecated": false,
+ "deprecated": true,
"firstVersion": "2.15.0",
"label": "file,cloud,api",
"javaType": "org.apache.camel.component.github.GitHubComponent",
diff --git
a/components/camel-github/src/generated/resources/META-INF/org/apache/camel/component/github/github.json
b/components/camel-github/src/generated/resources/META-INF/org/apache/camel/component/github/github.json
index 5edd3642a0ac..ef963344536f 100644
---
a/components/camel-github/src/generated/resources/META-INF/org/apache/camel/component/github/github.json
+++
b/components/camel-github/src/generated/resources/META-INF/org/apache/camel/component/github/github.json
@@ -4,7 +4,7 @@
"name": "github",
"title": "GitHub",
"description": "Interact with the GitHub API.",
- "deprecated": false,
+ "deprecated": true,
"firstVersion": "2.15.0",
"label": "file,cloud,api",
"javaType": "org.apache.camel.component.github.GitHubComponent",
diff --git a/components/camel-github/src/main/docs/github-component.adoc
b/components/camel-github/src/main/docs/github-component.adoc
index f9bbd4368008..d6334f416ce6 100644
--- a/components/camel-github/src/main/docs/github-component.adoc
+++ b/components/camel-github/src/main/docs/github-component.adoc
@@ -1,10 +1,11 @@
-= GitHub Component
+= GitHub Component (deprecated)
:doctitle: GitHub
:shortname: github
:artifactid: camel-github
:description: Interact with the GitHub API.
:since: 2.15
-:supportlevel: Stable
+:supportlevel: Stable-deprecated
+:deprecated: *deprecated*
:tabs-sync-option:
:component-header: Both producer and consumer are supported
//Manually maintained attributes
@@ -14,6 +15,12 @@
*{component-header}*
+[NOTE]
+====
+This component is deprecated since Camel 4.18 and will be removed in a future
release.
+Please use the xref:github2-component.adoc[GitHub2] component instead, which
uses the official https://github.com/hub4j/github-api[GitHub API for Java]
library.
+====
+
The GitHub component interacts with the GitHub API by
encapsulating https://git.eclipse.org/c/egit/egit-github.git/[egit-github]. It
currently provides polling for new pull requests, pull request comments,
diff --git
a/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubComponent.java
b/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubComponent.java
index 28488d3dab61..e23e81815b47 100644
---
a/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubComponent.java
+++
b/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubComponent.java
@@ -25,8 +25,11 @@ import org.apache.camel.support.HealthCheckComponent;
/**
* Represents the component that manages {@link GitHubEndpoint}.
+ *
+ * @deprecated since 4.18, use {@link
org.apache.camel.component.github2.GitHub2Component} (camel-github2) instead
*/
@Component("github")
+@Deprecated(since = "4.18")
public class GitHubComponent extends HealthCheckComponent {
@Metadata(label = "security", secret = true)
diff --git
a/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubEndpoint.java
b/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubEndpoint.java
index a16466df639c..73232393f3f4 100644
---
a/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubEndpoint.java
+++
b/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubEndpoint.java
@@ -60,9 +60,12 @@ import org.apache.camel.util.StringHelper;
* reliability/stability if this somehow relied on an exposed, embedded server
(Jetty?) - the types of payloads we're
* polling aren't typically large (plus, paging is available in the API) -
need to support apps running somewhere not
* publicly accessible where a webhook would fail
+ *
+ * @deprecated since 4.18, use {@link
org.apache.camel.component.github2.GitHub2Endpoint} (camel-github2) instead
*/
@UriEndpoint(firstVersion = "2.15.0", scheme = "github", title = "GitHub",
syntax = "github:type/branchName",
category = { Category.FILE, Category.CLOUD, Category.API },
headersClass = GitHubConstants.class)
+@Deprecated(since = "4.18")
public class GitHubEndpoint extends ScheduledPollEndpoint implements
EndpointServiceLocation {
@UriPath
diff --git
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
index 4066cf56cae2..da91e5da1f90 100644
---
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
+++
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
@@ -5445,6 +5445,7 @@ public class StaticEndpointBuilders {
* @param path type/branchName
* @return the dsl builder
*/
+ @Deprecated
public static GitHubEndpointBuilderFactory.GitHubEndpointBuilder
github(String path) {
return github("github", path);
}
@@ -5472,6 +5473,7 @@ public class StaticEndpointBuilders {
* @param path type/branchName
* @return the dsl builder
*/
+ @Deprecated
public static GitHubEndpointBuilderFactory.GitHubEndpointBuilder
github(String componentName, String path) {
return GitHubEndpointBuilderFactory.endpointBuilder(componentName,
path);
}
diff --git
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/GitHubEndpointBuilderFactory.java
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/GitHubEndpointBuilderFactory.java
index 7701aefd9bab..1ffe466ddb24 100644
---
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/GitHubEndpointBuilderFactory.java
+++
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/GitHubEndpointBuilderFactory.java
@@ -1064,6 +1064,7 @@ public interface GitHubEndpointBuilderFactory {
*
* @return the dsl builder for the headers' name.
*/
+ @Deprecated
default GitHubHeaderNameBuilder github() {
return GitHubHeaderNameBuilder.INSTANCE;
}
@@ -1089,6 +1090,7 @@ public interface GitHubEndpointBuilderFactory {
* @param path type/branchName
* @return the dsl builder
*/
+ @Deprecated
default GitHubEndpointBuilder github(String path) {
return GitHubEndpointBuilderFactory.endpointBuilder("github",
path);
}
@@ -1116,6 +1118,7 @@ public interface GitHubEndpointBuilderFactory {
* @param path type/branchName
* @return the dsl builder
*/
+ @Deprecated
default GitHubEndpointBuilder github(String componentName, String
path) {
return GitHubEndpointBuilderFactory.endpointBuilder(componentName,
path);
}
