[JENKINS-65813] Add @Symbol to support pipeline

[kinow]

Supersedes #43

Testing done

Submitter checklist

Beta Give feedback

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

[kinow]

@mawinter69 I think you had a comment about the HTML help files too. Would you have a suggestion on how these files should look like?

[mawinter69]

@mawinter69 I think you had a comment about the HTML help files too. Would you have a suggestion on how these files should look like?

Just put a help.html file next to the config.jelly of the parameters.

[kinow]

@mawinter69 I think you had a comment about the HTML help files too. Would you have a suggestion on how these files should look like?

Just put a help.html file next to the config.jelly of the parameters.

I thought you were suggesting improving the existing help files: https://github.com/jenkinsci/active-choices-plugin/tree/master/src/main/webapp

I will have a look to see if they are not being displayed. It worked in the past, but I haven't used it with newer versions.

[mawinter69]

The help is displayed, but what is missing is a general description of what the parameters are doing.
As an example look at the File Parameter. It has a help button right on top and explains how this parameter works.

Such help texts are missing for active choices and the only way to learn how they work is by visiting the plugin page.

[0054]

Any news?
this will be a very useful feature

[kinow]

Any news? this will be a very useful feature

Hi @0054

Had forgotten about this PR, thanks for the bump 👍 . I'm checking out the master branch, running the tests to confirm it's OK, and will rebase this PR.

If all goes well I hope this can be merged in the next hour to be included in the next release.

[kinow]

Rebased, push-forced. Let's wait for CI.

[kinow]

CI is good. Now trying to add the help files @mawinter69 pointed out we are missing here.

[kinow]

@mawinter69 each parameter now has its own help file displayed next to its type/name.

I wrote some quick description for each parameter, but @imoutsatsos or someone else can improve it later if needed, so we don't block this PR based on that 👍

Thanks for the feedback!

[kinow]

Righto, last requirement now

Ensure you have provided tests - that demonstrates feature works or fixes the issue

Let's see if I can find a way to test it now. (And maybe write some unit tests for this too. -- this part might take longer, so if someone can step in and help, then we should be able to release it much faster!)

[kinow]

Test for the help files added. It is a Selenium test that was failing, complaining that it would click on an element in the footer instead of on the help icon. Tried using the predefined timeout but that didn't work. Then set the resolution to a wider screen and it solved (I guessed it was using some default smaller resolution, causing the elements to overlap).

Just missing some manual tests with pipelines, and maybe a test for that too.

[kinow]

I don't think it's easy to write a test for this. I had to install the Pipeline plugin.

Then use the declarative generator to create a simple parameter.

Pasted into a pipeline job

Then build it to produce an updated job, and build with parameters is shown.

I will push one more commit with the updated change log, then merge it. To be included with next release (in days/weeks, need to sort out my user+pass to Jenkins repositories).

[MattLud]

Does this PR still need a corresponding test with declarative pipeline? I'd be happy to help add one.

[kinow]

Does this PR still need a corresponding test with declarative pipeline? I'd be happy to help add one.

Hi @MattLud , that'd be great! In this PR I only added one for the help files, so covering the declarative pipeline would be excellent!

Thanks