Details
-
Type:
Bug
-
Status: Closed (View Workflow)
-
Priority:
Major
-
Resolution: Incomplete
-
Component/s: favorite-plugin
-
Environment:Jenkins ver. 2.73.2
email-ext 2.6.0
favorite 2.3.1
token-macro 2.3
-
Similar Issues:
Description
When passing the ${FAVORITE_USERS_EMAIL} macro in the 'to:' line of a pipeline call to email-ext, jenkins errors with: "FAVORITE_USERS_EMAIL" is not supported in this context.
I also cannot expand the ${FAVORITE_USERS_EMAIL} token using the 'tk' step to get the list of users who have favorited a job and include them in the email. The same error message is thrown.
Attachments
Activity
m c
created issue -
| Field | Original Value | New Value |
|---|---|---|
| Labels | email-ext favorite pipeline | favorite pipeline |
| Component/s | email-ext-plugin [ 15538 ] | |
| Assignee | David van Laatum [ davidvanlaatum ] | James Dumay [ jamesdumay ] |
| Component/s | email-ext-plugin [ 15538 ] |
| Labels | favorite pipeline | email-ext favorite pipeline |
Can you please provide an example Jenkinsfile?
I too hit the same issue this morning. Any update or workaround with this issue?
rao rao
added a comment - I too hit the same issue this morning. Any update or workaround with this issue? Anyone have an example that James can look at? If not, I'll try and come up with one as I would like to get this resolved.
We tried this was various escape char combos for the "$", but we found that the environment variable on our system isn't showing up even for a simple echo call.
pipeline {
agent none
stages {
stage('Test Email') {
agent any
steps {
script {
try {
echo "emailext body: 'Hello World', recipientProviders: [recipients()], subject: 'Hi', to: '\$FAVORITE_USERS_EMAIL'"
emailext body: 'Hello World - fifth', recipientProviders: [recipients()], subject: 'Hi', to: '\$FAVORITE_USERS_EMAIL'
} catch(e) {
echo "${e.getMessage()}"
echo "Failed to send email"
}
}
}
}
}
}
is FAVORITE_USERS_EMAIL a token, or just a parameter?
| Resolution | Incomplete [ 4 ] | |
| Status | Open [ 1 ] | Closed [ 6 ] |
| Assignee | James Dumay [ jamesdumay ] | Alex Earl [ slide_o_mix ] |
The workaround that i did is below.
def email_list = [] if(fileExists ('favorites.txt')) { def file_contents = readFile 'favorites.txt' email_list = file_contents.tokenize('\n') echo "FILE CONTENTS OF FAVORITES ARE -- ${email_list}" } else { echo "FAVORITES FILE DOESNT EXIST" } emailext body: "${email_job_url}${currentBuild.description}", recipientProviders: [[$class: 'RequesterRecipientProvider']], mimeType: 'text/html', subject: "Pipeline '${env.JOB_NAME}' was ${currentBuild.result}", to: "${email_list.join(',')}"
rao rao
added a comment - The workaround that i did is below.
def email_list = []
if (fileExists ( 'favorites.txt' )) {
def file_contents = readFile 'favorites.txt'
email_list = file_contents.tokenize( '\n' )
echo "FILE CONTENTS OF FAVORITES ARE -- ${email_list}"
} else {
echo "FAVORITES FILE DOESNT EXIST"
}
emailext body: "${email_job_url}${currentBuild.description}" , recipientProviders: [[$class: 'RequesterRecipientProvider' ]], mimeType: 'text/html' , subject: "Pipeline '${env.JOB_NAME}' was ${currentBuild.result}" , to: "${email_list.join( ',' )}"
How did that text file get generated?
The Favorites plugin generates that file for each job that has been Favorited.
rao rao
added a comment - The Favorites plugin generates that file for each job that has been Favorited. Where is FAVORITE_USERS_EMAIL defined? Is it a job parameter, or an environment variable? I don't think it is a token (from token-macro). If it's a parameter or environment variable, you should be able to access it as:
emailext body: 'Hello World - fifth', recipientProviders: [recipients()], subject: 'Hi', to: FAVORITE_USERS_EMAIL
or
FAVORITE_USERS_EMAIL is a Token Macro as part of [Favorite |https://plugins.jenkins.io/favorite] plugin.
rao rao
added a comment - FAVORITE_USERS_EMAIL is a Token Macro as part of [Favorite | https://plugins.jenkins.io/favorite ] plugin. That token won't work in a pipeline job, it has not been updated to support pipeline.
| Component/s | email-ext-plugin [ 15538 ] |
| Assignee | Alex Earl [ slide_o_mix ] | James Dumay [ jamesdumay ] |
See https://github.com/jenkinsci/email-ext-plugin/blob/master/src/main/java/hudson/plugins/emailext/plugins/content/FailedTestsContent.java#L46-L96 for an example of how to allow the token to work in pipeline jobs.
Personally I would code as RecipientProvider rather than a token.