nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

ScriptRunner Script Roots

William Lupton

I'm trying to create a ScriptRunner Script Plugin, and have more-or-less followed these guidelines (I'm using later Jira and ScriptRunner versions and hope that I've edited the pom file correctly).

I have some scripts in my plugin (they're definitely in the JAR) and I'm hoping that installing the plugin will add a Script Root and make these scripts visible. However, this doesn't seem to be happening, and I'm not seeing the scripts or the script roots in the Source Editor.

I'm wondering whether I need to do something to somehow declare the existence of these scripts, e.g., add something to scriptrunner.yaml, scripts.properties or atlassian-plugin.xml.

I'd be very grateful for any suggestions. I can give more details, but thought I'd keep it simple to start with.

--- UPDATE #1 (2021-11-15) ---

I've looked into this a bit further by going back to the guidelines referenced above and creating two different builds (links are to branches in my fork):

(just-change-to-bbf) Making minimal changes (just changing names to use org.broadband_forum, although I should have just used com.example)
(remove-all-scripts) Removing all the scripts (removing all the Groovy classes and scripts)

When I run #just-change-to-bbf, I see the various scripts, e.g., script.groovy:

Screenshot 2021-11-15 at 11.57.14.png

But I'm almost sure that these are coming from the server directory, not from the plugin. If I uninstall the plugin they're still there:

Screenshot 2021-11-15 at 12.07.55.png

If I run #remove-all-scripts, as expected I don't see the scripts:

Screenshot 2021-11-15 at 12.11.45.png

But if I install the #just-change-to-bbf plugin (which should contain the scripts, yes?) I still don't see them: Screenshot 2021-11-15 at 12.13.38.png

The #just-change-to-bbf JAR file (unzipped into a temporary directory) looks like this:

hana:temp% unzip ../target/scriptrunner-plugin-just-change-to-bbf-1.0.0-SNAPSHOT.jar 
Archive: ../target/scriptrunner-plugin-just-change-to-bbf-1.0.0-SNAPSHOT.jar
creating: META-INF/
inflating: META-INF/MANIFEST.MF 
creating: css/
creating: images/
creating: js/
creating: org/
creating: org/broadband_forum/
creating: org/broadband_forum/scriptedfields/
creating: org/broadband_forum/main/
creating: org/broadband_forum/main/webfragments/
creating: org/broadband_forum/main/scriptedfields/
creating: org/broadband_forum/main/behaviours/
creating: org/broadband_forum/main/scripts/
creating: org/broadband_forum/main/listeners/
creating: org/broadband_forum/main/rest/
creating: META-INF/plugin-components/
creating: META-INF/spring/
inflating: css/scriptrunner-plugin-min.css 
inflating: css/scriptrunner-plugin.css 
inflating: images/pluginIcon.png 
inflating: images/pluginLogo.png 
inflating: js/scriptrunner-plugin.js 
inflating: js/scriptrunner-plugin-min.js 
inflating: scriptrunner-plugin.properties 
inflating: org/broadband_forum/scriptedfields/CreateScriptFieldUpgradeTask.class 
inflating: org/broadband_forum/scriptedfields/AbstractUpgradeTask.groovy 
inflating: org/broadband_forum/scriptedfields/AbstractUpgradeTask.class 
inflating: org/broadband_forum/scriptedfields/CreateScriptFieldUpgradeTask.groovy 
inflating: org/broadband_forum/main/webfragments/webfragments.class 
inflating: org/broadband_forum/main/webfragments/webfragments.groovy 
inflating: org/broadband_forum/main/scriptedfields/scriptedfield.class 
inflating: org/broadband_forum/main/scriptedfields/scriptedfield.groovy 
inflating: org/broadband_forum/main/behaviours/behaviour.class 
inflating: org/broadband_forum/main/behaviours/behaviour.groovy 
inflating: org/broadband_forum/main/scripts/script.groovy 
inflating: org/broadband_forum/main/scripts/script.class 
inflating: org/broadband_forum/main/listeners/listener.class 
inflating: org/broadband_forum/main/listeners/listener.groovy 
inflating: org/broadband_forum/main/rest/rest.class 
inflating: org/broadband_forum/main/rest/rest.groovy 
inflating: org/broadband_forum/main/rest/rest$_run_closure1.class 
inflating: scriptrunner.yaml 
inflating: META-INF/plugin-components/component 
inflating: META-INF/plugin-components/exports 
inflating: META-INF/spring/plugin-context.xml 
inflating: atlassian-plugin.xml 
creating: META-INF/maven/
creating: META-INF/maven/org.broadband_forum.scriptrunner/
creating: META-INF/maven/org.broadband_forum.scriptrunner/scriptrunner-plugin-just-change-to-bbf/
inflating: META-INF/maven/org.broadband_forum.scriptrunner/scriptrunner-plugin-just-change-to-bbf/pom.xml 
inflating: META-INF/maven/org.broadband_forum.scriptrunner/scriptrunner-plugin-just-change-to-bbf/pom.properties

Why aren't I seeing the scripts? I would think that the plugin:// script root URL would access the entire plugin tree, but is this wrong? Does it maybe "serve" a sub-hierarchy?

This is an old ScriptRunner version, and the version that I currently use doesn't give this list of script roots. Why is this (I rather like it)?

Accepted answers

Matthew Clark_fnk5v4

Hi William

I might be able to clear a few things up here:

1- Running the samples plugin with atlas-debug will add the plugins resource directory as a script root so yes you are correct they are coming from the server directory and not the plugin. They will not be there if you just installed the samples plugin jar into a separate Jira instance i.e. not run from your samples project with atlas-debug. You can compile just the jar for your plugin with the`atlas-package` command.

2- Auto completing the file paths for script file selectors does not work for the samples plugins at the moment, there is a bug for this here SRPLAT-935. I tested this again today and it also does not work in the latest version 6.39.0

You can still refer to the scripts inside the samples plugin resources directory but you have to manually enter the file path.

With regards to samples plugin file paths: The scripts need to be in the sample plugins resources folder before you compile it and the path starts from inside the resources folder (not including the resources folder). e.g. if I have a samples plugin directory structure and script like this `mysamplesplugin/jira/src/main/resources/com/mythings/myscripts.groovy`
the file path you need to use in ScriptRunners various features via the script file tab would be `com/mythings/myscripts.groovy`

3- We do not show the installed samples plugin roots in the script editor because those will be read-only directories and at the moment we do not show read-only script roots. The samples plugin roots are read-only because they are part of a plugin. i.e. contained inside its jar. You cannot edit these inside Jira, changes have to be made inside the sample plugins code (e.g: in an IDE), then you re-compile it and install it into Jira again.

Hope this helps

Regards
Matthew

All comments

James Poag

We too are having trouble with this and would like some resolution.

Matthew Clark_fnk5v4

Hi William

I might be able to clear a few things up here:

You can still refer to the scripts inside the samples plugin resources directory but you have to manually enter the file path.

Hope this helps

Regards
Matthew

PD Sheehan

Thank @Matthew Clark I was curious and tried to figure this out myself for the OP when it first appeared and wasn't able to.

Out of additional curiosity, I re-installed the test plugin I had created then and found that I was able to access a script in mysampleplugin/src/main/groovy/com/mythings/myscript.groovy by adding this to the console: com/mythings/myscript.groovy

But I was not able to access scripts from mysampleplugin/src/main/resources/com/mythings/myscript.groovy

Matthew Clark_fnk5v4

Exactly, `mysampleplugin/src/main/resources` is not part of the compiled plugins jar.

If you run `atlas-package` and take the compiled jar from the samples plugins `jira/target/` directory and then unzip the jar file you will see it stores your script in a structure like `com/mythings/myscript.groovy`

PD Sheehan

This is all really helpful. Thanks

Maybe I have something weird in my project (it's a sample from a training)... but I have these two files:

mysampleplugin/src/main/groovy/com/mycompany/mythings/test1.groovy
mysampleplugin/src/main/resources/com/mycompany/mythings/test2.groovy

After packaging,

I have these two paths

com/mycompany/mythings/test1.groovy
com.mycompany.mythings/test2.groovy

Notice the first is 4 directories deep (separated by /) while the second has only 1 directory with dots.

Either way ... it's good to know that scripts in plugin are available, you just have to figure out the correct path since autocomplete doesn't work.

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

server

scriptrunner

jira-software

jira-software-server