[JIRA] (JENKINS-59462) Support release notes from file

24 views
Skip to first unread message

timea.kerekgyarto@gmail.com (JIRA)

unread,
Sep 20, 2019, 6:55:03 AM9/20/19
to jenkinsc...@googlegroups.com
Timea Antal created an issue
 
Jenkins / New Feature JENKINS-59462
Support release notes from file
Issue Type: New Feature New Feature
Assignee: Mez Pahlan
Components: appcenter-plugin
Created: 2019-09-20 10:54
Labels: newbie-friendly
Priority: Major Major
Reporter: Timea Antal

Support updating the release with release notes specified in Markdown format.

PATCH
/v0.1/apps/{owner_name}/{app_name}/releases/{release_id}

Is the API that allows uploading of release notes.

Acceptance:

1. Users can enter release notes via the plugin front end.
2. The field is optional
3. Release notes sent via the API to AppCenter

Add Comment Add Comment
 
This message was sent by Atlassian Jira (v7.13.6#713006-sha1:cc4451f)
Atlassian logo

timea.kerekgyarto@gmail.com (JIRA)

unread,
Sep 20, 2019, 6:55:03 AM9/20/19
to jenkinsc...@googlegroups.com
Timea Antal updated an issue
Change By: Timea Antal
Released As: 0.6.0

timea.kerekgyarto@gmail.com (JIRA)

unread,
Sep 20, 2019, 6:55:04 AM9/20/19
to jenkinsc...@googlegroups.com
Timea Antal updated an issue
Change By: Timea Antal
Labels: newbie-friendly

timea.kerekgyarto@gmail.com (JIRA)

unread,
Sep 20, 2019, 6:58:02 AM9/20/19
to jenkinsc...@googlegroups.com
Timea Antal updated an issue
Support updating the *As a user I would like to upload release with release notes specified in Markdown format from a file . *

PATCH  
/v0.1/apps/\{owner_name\}/\{app_name\}/releases/\{release_id\}

Is
With the API that allows uploading hockeyapp plugin there were multiple options to upload release notes, one way of them was to upload release notes from file (' Load Release Notes from File') .

Acceptance:

1
For this to work I needed to provide only a changelog file path . Users can enter release notes via I would like to have the same feature in the appcenter plugin front end as well .
2. The field is optional
3. Release notes sent via the API to AppCenter

mez.pahlan@gmail.com (JIRA)

unread,
Sep 20, 2019, 7:08:02 AM9/20/19
to jenkinsc...@googlegroups.com
Mez Pahlan commented on New Feature JENKINS-59462
 
Re: Support release notes from file

Hi Timea Antal thanks for raising this. I do want to think about this as I think it is a good use case. For now I think you can read the file via existing pipeline functions and supply the text to the existing field. When I get home I can provide an example.

However this will have to wait for a bit. Hope you understand. Thanks.

timea.kerekgyarto@gmail.com (JIRA)

unread,
Sep 20, 2019, 7:10:02 AM9/20/19
to jenkinsc...@googlegroups.com

Hi Mez Pahlan! Thanks for the quick reply. If there is a workaround for it, and an example of how to do it, than it would be great, I can live with that for a while. Thanks! 

mez.pahlan@gmail.com (JIRA)

unread,
Sep 22, 2019, 6:55:03 AM9/22/19
to jenkinsc...@googlegroups.com

Hi Timea Antal apologies for the delay. I think something like this might work.

def changes = readFile 'path/to/changelog.md'

And then use this variable in a GString as the input to the AppCenter plugin

appCenter releaseNotes: "${changes}"

Note that this is a GString that support interpolation and not a regular string that doesn't.

Also note I haven't had time to try this but I have used this Pipeline step in the past to do similar things.

Let me know how you get on

mez.pahlan@gmail.com (JIRA)

unread,
Sep 22, 2019, 6:56:01 AM9/22/19
to jenkinsc...@googlegroups.com
Mez Pahlan edited a comment on New Feature JENKINS-59462
Hi [~timmi88] apologies for the delay. I think something like this _might_ work.

{code:groovy}

def changes = readFile 'path/to/changelog.md'
{code}


And then use this variable in a GString as the input to the AppCenter plugin

{code:groovy}appCenter releaseNotes: "${changes}"{code}

Note that this is a GString that
support supports string interpolation and not a regular string that doesn't.


Also note I haven't had time to try this but I have used this Pipeline step in the past to do similar things.

Let me know how you get on :)

stephan.wezel@promotion-software.de (JIRA)

unread,
Oct 9, 2019, 4:29:03 AM10/9/19
to jenkinsc...@googlegroups.com

The other possibility is using https://wiki.jenkins.io/display/JENKINS/EnvInject+Plugin to read the file into an env variable and reference this variable in appcenter  release notes property

mez.pahlan@gmail.com (JIRA)

unread,
Oct 26, 2019, 11:13:02 AM10/26/19
to jenkinsc...@googlegroups.com
Mez Pahlan assigned an issue to Unassigned
 
Change By: Mez Pahlan
Assignee: Mez Pahlan

mez.pahlan@gmail.com (JIRA)

unread,
Feb 8, 2020, 11:54:02 AM2/8/20
to jenkinsc...@googlegroups.com
Mez Pahlan started work on New Feature JENKINS-59462
 
Change By: Mez Pahlan
Status: Open In Progress

mez.pahlan@gmail.com (JIRA)

unread,
Feb 8, 2020, 11:54:03 AM2/8/20
to jenkinsc...@googlegroups.com
Mez Pahlan assigned an issue to Mez Pahlan
 
Jenkins / New Feature JENKINS-59462
Support release notes from file
Change By: Mez Pahlan
Assignee: Mez Pahlan

mez.pahlan@gmail.com (JIRA)

unread,
Mar 19, 2020, 6:51:08 PM3/19/20
to jenkinsc...@googlegroups.com
Mez Pahlan commented on New Feature JENKINS-59462
 
Re: Support release notes from file

There'll be a new field called pathToReleaseNotes that will be merged with releaseNotes up to a merged limit of 5000 characters in the next update.

This message was sent by Atlassian Jira (v7.13.12#713012-sha1:6e07c38)
Atlassian logo

mez.pahlan@gmail.com (JIRA)

unread,
Mar 19, 2020, 6:51:08 PM3/19/20
to jenkinsc...@googlegroups.com
Change By: Mez Pahlan
Status: In Review Fixed but Unreleased
Resolution: Fixed

mez.pahlan@gmail.com (JIRA)

unread,
Mar 19, 2020, 6:51:09 PM3/19/20
to jenkinsc...@googlegroups.com

mez.pahlan@gmail.com (JIRA)

unread,
May 3, 2020, 9:25:03 AM5/3/20
to jenkinsc...@googlegroups.com
Change By: Mez Pahlan
Status: Fixed but Unreleased Resolved
Released As: 0.9.0
Reply all
Reply to author
Forward
0 new messages