How to automate snap's changelog per release?


#1

Hello all,

Is there a way / any documentation to automate the snap’s changelog per release on dashboard.snapcraft.io? Something like Debian packager’s DEBIAN/changelog file.

Currently I’m copy pasting manually into the “changelog” field. I have an automator which can generate the CHANGELOG.md and DEBIAN/changelog updates per release as shown below and don’t mind upgrade it:

CHANGELOG.md

# Version 1.4.0
## Thu, 14 Mar 2019 12:00:19 +0800 - (Urgency: low)
--------------------------------------------------------------------------------
1. d0b9071 bissetii.sh: remove automatic manager.sh installation
2. c928127 root: updatd README.md and LICENSE to match the web documentation

# Version 1.3.0
## Thu, 14 Mar 2019 10:42:57 +0800 - (Urgency: low)
--------------------------------------------------------------------------------
1. f94cc29 .config/stingrays/manta.cfg: update to track staging as reference
2. 8126129 .fennec: added .fennec automation tool into repository
3. a06c4a6 .config/stingray/manta.cfg: added debian-mentors into unstable branch
4. 384682e repo/content/en-us/_index.md: changed the contents back to english
5. 80a87bd docs/*/specifications/file-structures.md: added stingrays directories
6. 147abb7 bissetii.sh: added _patch_repo_doc function
7. 315e5a5 repo/*: updated to match single install user experiences
8. 53bc793 .configs/stingrays: updated for building package
9. 876da3a bissetii.sh: added install/uninstall repo functions
10. 18ca4be assets/css/bissetii/libs/navbars: resized desktop sidebar
11. 9d2d1e7 docs/en-us/specifications: added upstream-process.md
12. 2b3daa5 docs/en-us/specifications: added logo-and-banner.md
13. f2a9e00 docs/en-us/specifications: added licensing.md
14. b2d27bc docs/en-us/specifications: added ci-pipelines.md
15. 5d9496d static: removed css directory
16. 219eea1 docs/en-us/specifications: added user-experiences.md into docs
17. 28c9968 docs/en-us/specifications: added file-structures.md into docs
18. 48e26ed docs/en-us/specifications: added design-concepts.md into docs
19. d6a2e7f archetypes/default.md: change to use multi-line strings for descriptions
20. 5cd266c layouts/partials/navigators/modules/_list.html: set active link to null
21. 468b504 doc/en-us/_index.md: fixed typo for Quick Dashboard
22. 6178809 docs/en-us/projects: added sponsoring page into documentation
23. 6d73fee docs/en-us: added project pages
24. 059e5d9 assets/css/bissetii/configs/colors: added GreenBamboo color
25. 47153c7 .sites/assets: removed unused assets directory
26. dd115b1 .gitignore: added Hugo _gen for resources
27. d231317 repo/*: updated based on local testing
28. af293ea .sites: added local website generator
29. 9bcd9e0 repo: updated to match a master template
...

DEBIAN/changelog template mode

bissetii (1.4.0DISTTAG) DISTSERIES; urgency=low

  *bissetii.sh: remove automatic manager.sh installation
  *root: updatd README.md and LICENSE to match the web documentation

 -- ZORALab Enterprise <tech@zoralab.com>  Thu, 14 Mar 2019 12:00:19 +0800

bissetii (1.3.0DISTTAG) DISTSERIES; urgency=low

  *.config/stingrays/manta.cfg: update to track staging as reference
  *.fennec: added .fennec automation tool into repository
  *.config/stingray/manta.cfg: added debian-mentors into unstable branch
  *repo/content/en-us/_index.md: changed the contents back to english
  *docs/*/specifications/file-structures.md: added stingrays directories
  *bissetii.sh: added _patch_repo_doc function
  *repo/*: updated to match single install user experiences
  *.configs/stingrays: updated for building package
  *bissetii.sh: added install/uninstall repo functions
  *assets/css/bissetii/libs/navbars: resized desktop sidebar
  *docs/en-us/specifications: added upstream-process.md
  *docs/en-us/specifications: added logo-and-banner.md
  *docs/en-us/specifications: added licensing.md
  *docs/en-us/specifications: added ci-pipelines.md
  *static: removed css directory
  *docs/en-us/specifications: added user-experiences.md into docs
  *docs/en-us/specifications: added file-structures.md into docs
  *docs/en-us/specifications: added design-concepts.md into docs
  *archetypes/default.md: change to use multi-line strings for descriptions
  *layouts/partials/navigators/modules/_list.html: set active link to null
  *doc/en-us/_index.md: fixed typo for Quick Dashboard
  *docs/en-us/projects: added sponsoring page into documentation
  *docs/en-us: added project pages
  *assets/css/bissetii/configs/colors: added GreenBamboo color
  *.sites/assets: removed unused assets directory
  *.gitignore: added Hugo _gen for resources
  *repo/*: updated based on local testing
  *.sites: added local website generator
  *repo: updated to match a master template

 -- ZORALab Enterprise <tech@zoralab.com>  Thu, 14 Mar 2019 10:42:57 +0800
...

#2

For those who is googling to this page: there isn’t a way yet. This is the same link as Automatically filling ChangeLog in the store. It’s a low priority feature so the snapcraft team will work on some higher priority works like bug fixes and etc.

Also, it isn’t important since the source codes itself is maintaining a version of changelog itself, like CHANGELOG.md recommended by most dvcs service providers or in-app changelog display (e.g. like Android application). Until there is a need and implemented an API or automated way to fill in, we have to fill it in manually.

For now, I will ignore the changelog from my side as filling manually in a duplicated way is wasting time. It’s better to redirect users to the maintained CHANGELOG.md site.


Not sure why I was being ignored entirely by the Snapcraft team since my last 2 posts. They used to be very responsive and helpful, even there is no good answer, they will acknowledge it happily and supportive as well.


#3

I don’t believe that they are being unresponsive on purpose. I know through the grapevine that some of them have travelling for conferences, etc. The other thing is, maybe they are investigating a few details prior to responding? And the reality is, we all suffer from notification fatigue and can potentially miss things (I know I do!) :slight_smile:

Hopefully they pipe up and you get the answer you need.

Have a great day.

Dustin Krysak