Home → Problems →

GitHub Release Description

• Edit

Jérémie Bertrand

25 Jan, 2015 03:28 PM

Hi,

I use the GitHub release feature which is really great.
But I haven't find any way to define the description of the release.

Is that possible?

Thanks.

1. Support Staff 1 Posted by Feodor Fitsner on 25 Jan, 2015 05:16 PM

   

   Nope, but this could be easily added.

   • Edit

2. 2 Posted by Jérémie Bertran... on 26 Jan, 2015 09:56 AM

   

   That would be excellent! :)
   Thanks.

   • Edit

3. Support Staff 3 Posted by Feodor Fitsner on 27 Jan, 2015 06:15 AM

   

   It's been deployed. There is a new provider setting description.

   • Edit

4. 4 Posted by Jérémie Bertran... on 28 Jan, 2015 06:27 AM

   

   Wow, you're the best!

   • Edit

5. 5 Posted by Pure Krome on 29 Jan, 2015 04:08 AM

   

   @Jeremie / @Feodor - what do you mean GH release feature please?

   /me is curious ;)

   • Edit

6. Support Staff 6 Posted by Feodor Fitsner on 29 Jan, 2015 04:10 AM

   

   Ah, there is deployment provider for creating GitHub release and pushing artifacts to it: http://www.appveyor.com/docs/deployment/github

   • Edit

7. 7 Posted by Pure Krome on 29 Jan, 2015 04:15 AM

   

   Ah! gotcha - cheers :) .. interesting ...

   • Edit

8. 8 Posted by Jérémie Bertran... on 25 Feb, 2015 06:31 AM

   

   I have just tested it with an environment variable, but sadly it seams that only the first line was taken:
   the value of the environment variable was:
   "Commits: [01422237dc...cb05b3fea6](https://github.com/laedit/SemanticReleaseNotesParser/compare/01422237dc...cb05b3fea6)
    
   # Enhancement
   - [#3](https://github.com/laedit/SemanticReleaseNotesParser/issues/3) - Support environment variable for AppVeyor
   - [#2](https://github.com/laedit/SemanticReleaseNotesParser/issues/2) - Support format in Html / Markdown
   - [#1](https://github.com/laedit/SemanticReleaseNotesParser/issues/1) - Respect Semantic Release Notes v 0.3"

   But only "Commits: [01422237dc...cb05b3fea6](https://github.com/laedit/SemanticReleaseNotesParser/compare/01422237dc...cb05b3fea6)" was used.

   Is it possible to take all the lines?
   Or to accept a file, with a descriptionfilepath parameter for example?

   In any case, thanks for your work! :)

   • Edit

9. Support Staff 9 Posted by Feodor Fitsner on 25 Feb, 2015 06:37 PM

   

   I think multi-line content won't work with environment variables. The idea with supplying a file name is nice, but I'm not sure how it should work in case of environment which doesn't have access to build files.

   Maybe we could just agree on some lines separator like \n, so in order to have multi-line value you'll put into environment variable something like:

   line1\nline2\nline3
   

   and AppVeyor will replace \n to a real CRLF. This will only work for GitHub release description.

   • Edit

10. 10 Posted by Jérémie Bertran... on 27 Feb, 2015 05:13 AM

    

    Why not just display a warning if the environment doesn't have access to build file?

    Anyway, the \n trick sounds good.

    And again thanks a lot for your hard work and responsiveness!

    • Edit

11. Support Staff 11 Posted by Feodor Fitsner on 27 Feb, 2015 05:19 AM

    

    OK, an update with \n support has been just deployed. Give it a try and let me know about results.

    • Edit

12. 12 Posted by Jérémie Bertran... on 27 Feb, 2015 05:53 AM

    

    Will do as soon as I can.
    Thanks! :)

    • Edit

13. 13 Posted by Jérémie Bertran... on 28 Feb, 2015 05:33 AM

    

    It's working!
    Build tested: https://ci.appveyor.com/project/laedit/av-gh-release-notes
    Result: https://github.com/laedit/AV-GH-release-notes/releases

    A big thanks!

    • Edit

14. Support Staff 14 Posted by Feodor Fitsner on 28 Feb, 2015 06:04 AM

    

    Cool, thanks for the update!

    • Edit

15. 15 Posted by Torsten on 12 Feb, 2017 04:13 PM

    

    I tried to set the description through an environment variable. But it seems that the description got shortend because of a size limit of environment variables. Any idea how to avoid that?

    Is there meantime a way to set the description of the release to the contents of a file?

    • Edit

16. Support Staff 16 Posted by Feodor Fitsner on 14 Feb, 2017 01:24 AM

    

    The only workaround here is using a custom script for publishing GitHub release. Look at this PowerShell example: https://github.com/FeodorFitsner/github-upload-tests/blob/master/up...

    • Edit

17. Ilya Finkelshteyn closed this discussion on 25 Aug, 2018 02:14 AM.