question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Create a CHANGELOG.md file

See original GitHub issue

Is your feature request related to a problem you are facing?

I have always wished that jitsi had a CHANGELOG.md file. It’s a good way for non-developers to track important changes to the software (perhaps new Stable versions), and to disseminate important news. The following revived my interest.

In #4758 @damencho wrote:

… Stable jitsi-meet now is 2.0.4468…

Is there currently a way that people can discover this?

Describe the solution you’d like

A CHANGELOG.md file could accomplish this. That file might only be updated when the main meet.jit.si server gets updated…

To keep it simple (and to minimize the effort), the entries could say:

2020-04-?? output of dpkg -l | grep jitsi followed by…

  • sentence about interesting change 1
  • sentence about interesting change 2
  • … maybe with links to issues/forum discussions/etc…

As a practical matter, the CHANGELOG.md file could simply start with today’s release and add new releases at the top. (I’m less interested in history.)

Describe alternatives you’ve considered

Create a README that tells people how to dig through sources, browser console messages, etc. to determine the current versions.

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Reactions:10
  • Comments:11 (5 by maintainers)

github_iconTop GitHub Comments

7reactions
chaoflowcommented, May 1, 2020

@damencho Since recently, I’m subscribed to the release notifications for jitsi, which I receive by email. Looking at the latest release, in order to assess whether I want to update, I had to:

  1. Follow the link to the release page contained in the e-mail
  2. Follow the link to the changelog file
  3. Acknowledge download and open in editor
  4. Parse approx 200 lines / 100 items for whether they contain something I need

I think this could be improved by:

  1. Using the generated changelog as base for a structured changelog taking ideas from keepachangelog. Beyond the sections proposed there, I think it would make sense to have a dedicated section for translations or leave them in the other sections, with common prefix and grouped together
  2. letting release notes contain changelog verbatim so it can be inspected right away in the release notification email
  3. Gather these in a top-level changelog file for easy inspection of release history

Thank you everybody involved for this great tool!

2reactions
tpocommented, Aug 31, 2020

thanks for reopening @Echolon

Read more comments on GitHub >

github_iconTop Results From Across the Web

A Beginner's Guide to Git — What is a Changelog and How to ...
A changelog is a file that shares a chronologically ordered list of the changes you've made on your project. It's often organized by...
Read more >
Generate a changelog from git commits. - GitHub
It's possible to create a ./CHANGELOG.md file for a specific commit range: generate-changelog 420c945...2a83752. Git tags are supported too:.
Read more >
How To Automatically Generate A Helpful Changelog From ...
Creating a changelog is a usual task if a new software version is going to be released. It contains all the changes which...
Read more >
Keep a Changelog
A changelog is a file which contains a curated, chronologically ordered list of notable changes for each version of a project. Why keep...
Read more >
What are some good ways to manage a changelog using Git?
If you want to generate a changelog from your Git history, you'll probably have to consider: ... Be stored to a file, like...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found