Skip to content

[backport camel-4.18.x] CAMEL-23582: camel-github2 - align Exchange header constant names with Camel naming convention #23537

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.

Sign up for GitHub

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

Merged
oscerd merged 1 commit into from
May 27, 2026
Merged

[backport camel-4.18.x] CAMEL-23582: camel-github2 - align Exchange header constant names with Camel naming convention #23537

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions ...og/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/github2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@
"oauthToken": { "index": 6, "kind": "property", "displayName": "Oauth Token", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "description": "GitHub OAuth token. Must be configured on either component or endpoint." }
},
"headers": {
"GitHubPullRequest": { "index": 0, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "org.kohsuke.github.GHPullRequest or Integer", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The pull request", "constantName": "org.apache.camel.component.github2.GitHub2Constants#GITHUB_PULLREQUEST" },
"GitHubInResponseTo": { "index": 1, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "Long", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The id of the comment to reply to", "constantName": "org.apache.camel.component.github2.GitHub2Constants#GITHUB_INRESPONSETO" },
"GitHubPullRequestHeadCommitSHA": { "index": 2, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The sha of the head of the pull request", "constantName": "org.apache.camel.component.github2.GitHub2Constants#GITHUB_PULLREQUEST_HEAD_COMMIT_SHA" },
"GitHubIssueTitle": { "index": 3, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The title of the issue", "constantName": "org.apache.camel.component.github2.GitHub2Constants#GITHUB_ISSUE_TITLE" },
"CamelGitHubPullRequest": { "index": 0, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "org.kohsuke.github.GHPullRequest or Integer", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The pull request", "constantName": "org.apache.camel.component.github2.GitHub2Constants#GITHUB_PULLREQUEST" },
"CamelGitHubInResponseTo": { "index": 1, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "Long", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The id of the comment to reply to", "constantName": "org.apache.camel.component.github2.GitHub2Constants#GITHUB_INRESPONSETO" },
"CamelGitHubPullRequestHeadCommitSha": { "index": 2, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The sha of the head of the pull request", "constantName": "org.apache.camel.component.github2.GitHub2Constants#GITHUB_PULLREQUEST_HEAD_COMMIT_SHA" },
"CamelGitHubIssueTitle": { "index": 3, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The title of the issue", "constantName": "org.apache.camel.component.github2.GitHub2Constants#GITHUB_ISSUE_TITLE" },
"CamelGitHubCommitAuthor": { "index": 4, "kind": "header", "displayName": "", "group": "consumer", "label": "consumer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The commit author", "constantName": "org.apache.camel.component.github2.GitHub2Constants#GITHUB_COMMIT_AUTHOR" },
"CamelGitHubCommitCommitter": { "index": 5, "kind": "header", "displayName": "", "group": "consumer", "label": "consumer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The committer name", "constantName": "org.apache.camel.component.github2.GitHub2Constants#GITHUB_COMMIT_COMMITTER" },
"CamelGitHubCommitSha": { "index": 6, "kind": "header", "displayName": "", "group": "consumer", "label": "consumer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The commit sha", "constantName": "org.apache.camel.component.github2.GitHub2Constants#GITHUB_COMMIT_SHA" },
Expand Down
8 changes: 4 additions & 4 deletions ...-github2/src/generated/resources/META-INF/org/apache/camel/component/github2/github2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@
"oauthToken": { "index": 6, "kind": "property", "displayName": "Oauth Token", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "description": "GitHub OAuth token. Must be configured on either component or endpoint." }
},
"headers": {
"GitHubPullRequest": { "index": 0, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "org.kohsuke.github.GHPullRequest or Integer", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The pull request", "constantName": "org.apache.camel.component.github2.GitHub2Constants#GITHUB_PULLREQUEST" },
"GitHubInResponseTo": { "index": 1, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "Long", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The id of the comment to reply to", "constantName": "org.apache.camel.component.github2.GitHub2Constants#GITHUB_INRESPONSETO" },
"GitHubPullRequestHeadCommitSHA": { "index": 2, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The sha of the head of the pull request", "constantName": "org.apache.camel.component.github2.GitHub2Constants#GITHUB_PULLREQUEST_HEAD_COMMIT_SHA" },
"GitHubIssueTitle": { "index": 3, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The title of the issue", "constantName": "org.apache.camel.component.github2.GitHub2Constants#GITHUB_ISSUE_TITLE" },
"CamelGitHubPullRequest": { "index": 0, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "org.kohsuke.github.GHPullRequest or Integer", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The pull request", "constantName": "org.apache.camel.component.github2.GitHub2Constants#GITHUB_PULLREQUEST" },
"CamelGitHubInResponseTo": { "index": 1, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "Long", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The id of the comment to reply to", "constantName": "org.apache.camel.component.github2.GitHub2Constants#GITHUB_INRESPONSETO" },
"CamelGitHubPullRequestHeadCommitSha": { "index": 2, "kind": "header", "displayName": "", "group": "common", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The sha of the head of the pull request", "constantName": "org.apache.camel.component.github2.GitHub2Constants#GITHUB_PULLREQUEST_HEAD_COMMIT_SHA" },
"CamelGitHubIssueTitle": { "index": 3, "kind": "header", "displayName": "", "group": "producer", "label": "producer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The title of the issue", "constantName": "org.apache.camel.component.github2.GitHub2Constants#GITHUB_ISSUE_TITLE" },
"CamelGitHubCommitAuthor": { "index": 4, "kind": "header", "displayName": "", "group": "consumer", "label": "consumer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The commit author", "constantName": "org.apache.camel.component.github2.GitHub2Constants#GITHUB_COMMIT_AUTHOR" },
"CamelGitHubCommitCommitter": { "index": 5, "kind": "header", "displayName": "", "group": "consumer", "label": "consumer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The committer name", "constantName": "org.apache.camel.component.github2.GitHub2Constants#GITHUB_COMMIT_COMMITTER" },
"CamelGitHubCommitSha": { "index": 6, "kind": "header", "displayName": "", "group": "consumer", "label": "consumer", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The commit sha", "constantName": "org.apache.camel.component.github2.GitHub2Constants#GITHUB_COMMIT_SHA" },
Expand Down
8 changes: 4 additions & 4 deletions ...ents/camel-github2/src/main/java/org/apache/camel/component/github2/GitHub2Constants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ public interface GitHub2Constants {
String GITHUB_CLIENT = "github2Client";

@Metadata(description = "The pull request", javaType = "org.kohsuke.github.GHPullRequest or Integer")
String GITHUB_PULLREQUEST = "GitHubPullRequest";
String GITHUB_PULLREQUEST = "CamelGitHubPullRequest";
@Metadata(label = "producer", description = "The id of the comment to reply to", javaType = "Long")
String GITHUB_INRESPONSETO = "GitHubInResponseTo";
String GITHUB_INRESPONSETO = "CamelGitHubInResponseTo";
@Metadata(description = "The sha of the head of the pull request", javaType = "String")
String GITHUB_PULLREQUEST_HEAD_COMMIT_SHA = "GitHubPullRequestHeadCommitSHA";
String GITHUB_PULLREQUEST_HEAD_COMMIT_SHA = "CamelGitHubPullRequestHeadCommitSha";
@Metadata(label = "producer", description = "The title of the issue", javaType = "String")
String GITHUB_ISSUE_TITLE = "GitHubIssueTitle";
String GITHUB_ISSUE_TITLE = "CamelGitHubIssueTitle";

@Metadata(label = "consumer", description = "The commit author", javaType = "String")
String GITHUB_COMMIT_AUTHOR = "CamelGitHubCommitAuthor";
Expand Down
4 changes: 2 additions & 2 deletions ...2/src/main/java/org/apache/camel/component/github2/producer/ClosePullRequestProducer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@
import org.kohsuke.github.GHPullRequest;

/**
* Producer endpoint that closes a pull request. The endpoint requires the "GitHubPullRequest" header, identifying the
* pull request number (integer).
* Producer endpoint that closes a pull request. The endpoint requires the "CamelGitHubPullRequest" header, identifying
* the pull request number (integer).
*/
public class ClosePullRequestProducer extends AbstractGitHub2Producer {

Expand Down
4 changes: 2 additions & 2 deletions ...ithub2/src/main/java/org/apache/camel/component/github2/producer/CreateIssueProducer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@
import org.kohsuke.github.GHIssue;

/**
* Producer endpoint that creates an issue. The endpoint requires the "GitHubIssueTitle" header, which sets the GitHub
* issue title. The issue body content is set from the exchange message body.
* Producer endpoint that creates an issue. The endpoint requires the "CamelGitHubIssueTitle" header, which sets the
* GitHub issue title. The issue body content is set from the exchange message body.
*/
public class CreateIssueProducer extends AbstractGitHub2Producer {

Expand Down
6 changes: 3 additions & 3 deletions ...src/main/java/org/apache/camel/component/github2/producer/PullRequestCommentProducer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@
/**
* Producer endpoint that adds a comment on a GitHub pull request.
*
* The endpoint requires the "GitHubPullRequest" header, identifying the pull request number (integer). If the
* "GitHubInResponseTo" header is provided (identifying a comment ID), the comment will be a reply to that comment (if
* supported).
* The endpoint requires the "CamelGitHubPullRequest" header, identifying the pull request number (integer). If the
* "CamelGitHubInResponseTo" header is provided (identifying a comment ID), the comment will be a reply to that comment
* (if supported).
*/
public class PullRequestCommentProducer extends AbstractGitHub2Producer {

Expand Down
2 changes: 1 addition & 1 deletion ...2/src/main/java/org/apache/camel/component/github2/producer/PullRequestFilesProducer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
import org.kohsuke.github.GHPullRequestFileDetail;

/**
* Producer endpoint that gets the list of files in a pull request. The endpoint requires the "GitHubPullRequest"
* Producer endpoint that gets the list of files in a pull request. The endpoint requires the "CamelGitHubPullRequest"
* header, identifying the pull request number (integer).
*/
public class PullRequestFilesProducer extends AbstractGitHub2Producer {
Expand Down
4 changes: 2 additions & 2 deletions ...2/src/main/java/org/apache/camel/component/github2/producer/PullRequestStateProducer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@
/**
* Producer endpoint that sets the commit status.
*
* The endpoint requires the "GitHubPullRequestHeadCommitSHA" header, identifying the commit SHA on which the state will
* be recorded.
* The endpoint requires the "CamelGitHubPullRequestHeadCommitSha" header, identifying the commit SHA on which the state
* will be recorded.
*/
public class PullRequestStateProducer extends AbstractGitHub2Producer {

Expand Down
41 changes: 41 additions & 0 deletions docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_18.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -361,6 +361,47 @@ As a consequence, the generated Endpoint DSL header accessors on



=== camel-github2 - potential breaking change

The producer-side Exchange header constants in `GitHub2Constants` have been
renamed to follow the Camel naming convention used across the rest of the
component catalog. The Java field names are unchanged; only the header string
values have changed:

[options="header"]
|===
| Constant | Previous value | New value
| `GitHub2Constants.GITHUB_PULLREQUEST` | `GitHubPullRequest` | `CamelGitHubPullRequest`
| `GitHub2Constants.GITHUB_INRESPONSETO` | `GitHubInResponseTo` | `CamelGitHubInResponseTo`
| `GitHub2Constants.GITHUB_PULLREQUEST_HEAD_COMMIT_SHA` | `GitHubPullRequestHeadCommitSHA` | `CamelGitHubPullRequestHeadCommitSha`
| `GitHub2Constants.GITHUB_ISSUE_TITLE` | `GitHubIssueTitle` | `CamelGitHubIssueTitle`
|===

The consumer-side constants (`GITHUB_COMMIT_AUTHOR`, `GITHUB_COMMIT_COMMITTER`,
`GITHUB_COMMIT_SHA`, `GITHUB_COMMIT_URL`, `GITHUB_EVENT_PAYLOAD`) were already
`Camel`-prefixed (`CamelGitHubCommitAuthor`, etc.) and are unchanged, as is the
`GITHUB_CLIENT` registry-lookup key (`github2Client`).

Routes that reference the constants symbolically (for example
`setHeader(GitHub2Constants.GITHUB_PULLREQUEST, ...)`) continue to work without
changes. Routes that set the header by its literal string value (for example
`setHeader("GitHubPullRequest", ...)`) must be updated to use the new value
(`setHeader("CamelGitHubPullRequest", ...)`).

As a consequence, the generated Endpoint DSL header accessor
`gitHubPullRequestHeadCommitSHA()` on `GitHub2HeaderNameBuilder` has been
renamed to `gitHubPullRequestHeadCommitSha()`. The remaining accessors
(`gitHubPullRequest()`, `gitHubInResponseTo()`, `gitHubIssueTitle()`) keep
their names but now return the new `Camel`-prefixed values.

NOTE: The deprecated `camel-github` component (predecessor of `camel-github2`)
is not affected by this change on the 4.18.x line; it remains present in
4.18.x as deprecated and was only removed on the 4.21 development branch.





=== camel-web3j - potential breaking change

The Exchange header constants in `Web3jConstants` have been renamed to follow the
Expand Down
12 changes: 6 additions & 6 deletions ...c/generated/java/org/apache/camel/builder/endpoint/dsl/GitHub2EndpointBuilderFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1182,7 +1182,7 @@ public static class GitHub2HeaderNameBuilder {
* @return the name of the header {@code GitHubPullRequest}.
*/
public String gitHubPullRequest() {
return "GitHubPullRequest";
return "CamelGitHubPullRequest";
}
/**
* The id of the comment to reply to.
Expand All @@ -1194,7 +1194,7 @@ public String gitHubPullRequest() {
* @return the name of the header {@code GitHubInResponseTo}.
*/
public String gitHubInResponseTo() {
return "GitHubInResponseTo";
return "CamelGitHubInResponseTo";
}
/**
* The sha of the head of the pull request.
Expand All @@ -1204,10 +1204,10 @@ public String gitHubInResponseTo() {
* Group: common
*
* @return the name of the header {@code
* GitHubPullRequestHeadCommitSHA}.
* GitHubPullRequestHeadCommitSha}.
*/
public String gitHubPullRequestHeadCommitSHA() {
return "GitHubPullRequestHeadCommitSHA";
public String gitHubPullRequestHeadCommitSha() {
return "CamelGitHubPullRequestHeadCommitSha";
}
/**
* The title of the issue.
Expand All @@ -1219,7 +1219,7 @@ public String gitHubPullRequestHeadCommitSHA() {
* @return the name of the header {@code GitHubIssueTitle}.
*/
public String gitHubIssueTitle() {
return "GitHubIssueTitle";
return "CamelGitHubIssueTitle";
}
/**
* The commit author.
Expand Down
Loading