Support withCredentials on PersonalAccessToken(Impl) #113

sahilm02 · 2025-04-22T16:51:23Z

MultiBinding implementation for the PersonalAccessTokenImpl class PersonalAccessToken interface.

Testing done

A test was introduced to run the complete pipeline and validate withCredentials, using both the full $class syntax and the personalAccessTokenId binding.

Submitter checklist

Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
Ensure that the pull request title represents the desired changelog entry
Please describe what you did
Link to relevant issues in GitHub or Jira
Link to relevant pull requests, esp. upstream and downstream changes
Ensure you have provided tests - that demonstrates feature works or fixes the issue

MarkEWaite

Minor change needed to sort the imports in order to satisfy checkstyle.

src/test/java/org/jenkinsci/plugin/gitea/credentials/PersonalAccessTokenBindingTest.java

Testing done: Confirmed that the Pipeline syntax snippet generator shows the correct syntax, of the form: withCredentials([giteaPersonalAccessToken(credentialsId: 'my-gitea-token', variable: 'MY_VAR')]) { // some block } Confirmed that the localized form of the variable property and the credentials property are displayed as expected. Confirmed that my sample Pipeline worked: pipeline { agent { label 'alpine' } stages { stage('Checkout') { steps { withCredentials([giteaPersonalAccessToken(credentialsId: 'gitea-token', variable: 'ABC')]) { sh 'git clone http://[email protected]:3000/mwaite/bin.git' } } } } }

MarkEWaite · 2025-04-25T03:37:21Z

The Jenkins Pipeline syntax snippet generator needs some additions to the pull request. The file src/main/resources/org/jenkinsci/plugin/gitea/credentials/PersonalAccessTokenBinding/config.jelly is needed in order to allow the generator to display the form.

I've made several changes and tested my changes interactively and think that they are ready for you to consider including them in this pull request.

https://github.com/MarkEWaite/gitea-plugin/tree/feature/withCredentials-support

…ccessTokenBindingTest.java Co-authored-by: Mark Waite <[email protected]>

No need to declare the package of the script. Use the default. No need to declare the full path to the PersonalAccessTokenBinding class, let Jenkins find it by searching. Add a newline to the end of the file.

…/gitea-plugin into feature/withCredentials-support

Guidance on quoting is adapted from https://github.com/jenkinsci/credentials-binding-plugin/edit/master/README.md

MarkEWaite · 2025-04-25T11:11:43Z

I added two more changes for your consideration:

c214a56 Add giteaPersonalAccessToken documentation and example
33b0b22 Simplify test script

…rt' into feature/withCredentials-support

The echo step is more common in Pipeline

MarkEWaite

This has passed my interactive testing, works with the Pipeline syntax snippet generator, works with localized versions of the Variable and Credentials property, includes documentation, and includes automated tests that exercise the new functionality.

I'd appreciate an (optional) review from @jglick as the expert on credentials binding implementations, but I accept that he may not have time to review it. I believe this is ready to merge and release.

MarkEWaite · 2025-04-25T11:44:05Z

@sahilm02 I added two more items for your consideration:

f9e1723 Improve comment in test
47258b9 Use echo instead of println

…rt' into feature/withCredentials-support

jglick · 2025-04-25T21:26:55Z

From a ten-second glance this looks like the wrong approach: you should rather implement StringCredentials and use the generic binding.

MarkEWaite · 2025-04-26T20:07:17Z

From a ten-second glance this looks like the wrong approach: you should rather implement StringCredentials and use the generic binding.

I'm not sure if I understood your comment correctly. I used StringBinding for the implementation and adjusted PersonalAccessToken to implement StringCredentials.

af1c198 is the change

sahilm02 · 2025-04-28T07:59:39Z

From a ten-second glance this looks like the wrong approach: you should rather implement StringCredentials and use the generic binding.

I'm not sure if I understood your comment correctly. I used StringBinding for the implementation and adjusted PersonalAccessToken to implement StringCredentials.

af1c198 is the change

@jglick Please let me know if this change looks good to you. If so, I will incorporate it into the PR.

jglick · 2025-04-29T17:56:11Z

If PersonalAccessTokenImpl implements StringCredentials then you should not need PersonalAccessTokenBinding at all. Just use the standard StringBinding.

withCredentials([string(credentialsId: 'happens-to-be-gitea', variable: 'GITEA_TOKEN')]) {…}

It is not really clear to my why PersonalAccessTokenImpl exists, either. It does not appear to have any special behavior beyond the standard StringCredentialsImpl other than warning you when the value is not 40 characters. In general, plugins should avoid defining new Credentials interfaces or implementations unless the generic ones fundamentally lack some required structure (typically multiple secret fields); for example, you prevent use of arbitrary CredentialsStore implementations, like https://plugins.jenkins.io/kubernetes-credentials-provider/ etc. or at least force them to add a special-case integration.

Not immediately obvious from the snippet generator.

MarkEWaite · 2025-04-29T19:32:31Z

Thanks for the feedback @jglick . I've updated with two more commits, removing the binding class and updating the automated test. The changes are:

6ae6216 - Document that 'Secret text' must be selected for Gitea tokens
ba4aa66 - Use StringCredentials

MarkEWaite · 2025-04-29T19:33:17Z

It is not really clear to my why PersonalAccessTokenImpl exists, either.

Since that class has existed since 2017, I left it alone. I didn't want to do the compatibility search to see if other plugins depend on it.

MarkEWaite · 2025-04-30T01:33:55Z

Another test case that I ran successfully, using a declarative Pipeline with the environment directive:

pipeline {
    environment {
        ABC = credentials('gitea-token')
    }
    agent {
        label '!cloud'
    }
    stages {
        stage('Checkout') {
            steps {
                cleanWs()
                script {
                    if (isUnix()) {
                        sh 'git clone https://[email protected]/user/repo.git'
                        sh 'ls'
                    } else {
                        bat 'git clone https://%ABC%@gitea.com/user/repo.git'
                        bat 'dir'
                    }
                }
            }
        }
    }
}

…using-StringCredentials

lafriks · 2025-11-26T16:24:41Z

@MarkEWaite could you please create a new PR with your fixes?

…ngCredentials

MarkEWaite · 2025-11-26T17:57:40Z

@MarkEWaite could you please create a new PR with your fixes?

I would much prefer that @sahilm02 receives credit for the work. @sahilm02 would you be willing to include the changes from my feature/withCredentials-support-using-StringCredentials branch?

If @sahilm02 does not respond within a week, I can rework my pull request to start with the original commits from @sahilm02 so that the commit history will correctly show the work of @sahilm02 . The current commits on my branch show me as the author of changes that were actually made by @sahilm02

sahilm02 · 2025-12-02T03:54:52Z

@MarkEWaite could you please create a new PR with your fixes?

I would much prefer that @sahilm02 receives credit for the work. @sahilm02 would you be willing to include the changes from my feature/withCredentials-support-using-StringCredentials branch?

If @sahilm02 does not respond within a week, I can rework my pull request to start with the original commits from @sahilm02 so that the commit history will correctly show the work of @sahilm02 . The current commits on my branch show me as the author of changes that were actually made by @sahilm02

I will incorporate your changes. Thanks

…rt-using-StringCredentials' into feature/withCredentials-support

…/gitea-plugin into feature/withCredentials-support

MarkEWaite

3 files that need to be removed from the pull request and 1 optional change to a test.

Thanks very much @sahilm02

MarkEWaite · 2025-12-04T23:25:26Z

src/main/java/org/jenkinsci/plugin/gitea/credentials/PersonalAccessTokenBinding.java

@@ -0,0 +1,58 @@
+package org.jenkinsci.plugin.gitea.credentials;


This file can be deleted. As noted by Jesse Glick, it is not needed because the binding is using the StringCredentials class rather than implementing its own class

MarkEWaite · 2025-12-04T23:26:09Z

...ain/resources/org/jenkinsci/plugin/gitea/credentials/PersonalAccessTokenBinding/config.jelly

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>


This file can be deleted. As noted by Jesse Glick, it is not needed because the binding is using the StringCredential rather than implementing its own class

MarkEWaite · 2025-12-04T23:26:23Z

...urces/org/jenkinsci/plugin/gitea/credentials/PersonalAccessTokenBinding/config_ja.properties

@@ -0,0 +1,24 @@
+# The MIT License


This file can be deleted. As noted by Jesse Glick, it is not needed because the binding is using the StringCredential rather than implementing its own class

MarkEWaite · 2025-12-04T23:28:10Z

src/test/java/org/jenkinsci/plugin/gitea/credentials/PersonalAccessTokenBindingTest.java

+        Run<?, ?> build = jenkins.buildAndAssertSuccess(project);
+        // Pipeline script outputs a substring of credential so that it will not be masked
+        jenkins.assertLogContains("Token1 is ecret", build);
+        jenkins.assertLogContains("Token2 is ecret", build);


This assertion was added to check that credential masking is working as expected on Windows and Unix. It is optional (no problem if you choose to not include it).

Suggested change

jenkins.assertLogContains("Token2 is ecret", build);

// Pipeline script shell and bat masks credential

jenkins.assertLogContains("API_TOKEN1 is ****", build);

withCredentials support -- initial implementation and tests

566eedc

MarkEWaite suggested changes Apr 25, 2025

View reviewed changes

src/test/java/org/jenkinsci/plugin/gitea/credentials/PersonalAccessTokenBindingTest.java Show resolved Hide resolved

MarkEWaite added 2 commits April 24, 2025 20:05

Sort the imports on new test

4626f86

sahilm02 and others added 4 commits April 25, 2025 12:29

Update src/test/java/org/jenkinsci/plugin/gitea/credentials/PersonalA…

4bb4317

…ccessTokenBindingTest.java Co-authored-by: Mark Waite <[email protected]>

Simplify test script

33b0b22

No need to declare the package of the script. Use the default. No need to declare the full path to the PersonalAccessTokenBinding class, let Jenkins find it by searching. Add a newline to the end of the file.

Merge branch 'feature/withCredentials-support' of github.com:sahilm02…

38e517e

…/gitea-plugin into feature/withCredentials-support

Add giteaPersonalAccessToken documentation and example

c214a56

Guidance on quoting is adapted from https://github.com/jenkinsci/credentials-binding-plugin/edit/master/README.md

sahilm02 and others added 3 commits April 25, 2025 16:43

Merge remote-tracking branch 'markwaite/feature/withCredentials-suppo…

9667755

…rt' into feature/withCredentials-support

Use echo instead of println

47258b9

The echo step is more common in Pipeline

Improve comment in test

f9e1723

MarkEWaite approved these changes Apr 25, 2025

View reviewed changes

Merge remote-tracking branch 'markwaite/feature/withCredentials-suppo…

c89581d

…rt' into feature/withCredentials-support

Use StringCredentials

b4388d9

MarkEWaite added 2 commits April 29, 2025 13:21

Use StringCredentials

ba4aa66

Choose 'Secret text' credential from snippet generator

6ae6216

Not immediately obvious from the snippet generator.

Merge branch 'jenkinsci:master' into feature/withCredentials-support-…

9bd7c77

…using-StringCredentials

MarkEWaite added 2 commits November 26, 2025 09:57

Merge branch 'master' into feature/withCredentials-support-using-Stri…

8401187

…ngCredentials

Include sh and bat in example and test

c71a294

Merge branch 'master' into feature/withCredentials-support

8978f4a

sahilm02 added 2 commits December 2, 2025 09:56

Merge remote-tracking branch 'markwaite/feature/withCredentials-suppo…

df93222

…rt-using-StringCredentials' into feature/withCredentials-support

Merge branch 'feature/withCredentials-support' of github.com:sahilm02…

80946b7

…/gitea-plugin into feature/withCredentials-support

MarkEWaite suggested changes Dec 4, 2025

View reviewed changes

		@@ -0,0 +1,58 @@
		package org.jenkinsci.plugin.gitea.credentials;

	jenkins.assertLogContains("Token2 is ecret", build);
	// Pipeline script shell and bat masks credential
	jenkins.assertLogContains("API_TOKEN1 is ****", build);

Support withCredentials on PersonalAccessToken(Impl) #113

Are you sure you want to change the base?

Support withCredentials on PersonalAccessToken(Impl) #113

Uh oh!

Conversation

sahilm02 commented Apr 22, 2025

Testing done

Submitter checklist

Uh oh!

MarkEWaite left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

MarkEWaite commented Apr 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MarkEWaite commented Apr 25, 2025

Uh oh!

MarkEWaite left a comment

Choose a reason for hiding this comment

Uh oh!

MarkEWaite commented Apr 25, 2025

Uh oh!

jglick commented Apr 25, 2025

Uh oh!

MarkEWaite commented Apr 26, 2025

Uh oh!

sahilm02 commented Apr 28, 2025

Uh oh!

jglick commented Apr 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MarkEWaite commented Apr 29, 2025

Uh oh!

MarkEWaite commented Apr 29, 2025

Uh oh!

MarkEWaite commented Apr 30, 2025

Uh oh!

lafriks commented Nov 26, 2025

Uh oh!

MarkEWaite commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sahilm02 commented Dec 2, 2025

Uh oh!

MarkEWaite left a comment

Choose a reason for hiding this comment

Uh oh!

MarkEWaite Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

MarkEWaite Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

MarkEWaite Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

MarkEWaite Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

MarkEWaite commented Apr 25, 2025 •

edited

Loading

jglick commented Apr 29, 2025 •

edited

Loading

MarkEWaite commented Nov 26, 2025 •

edited

Loading