pudb icon indicating copy to clipboard operation
pudb copied to clipboard

Add changelog

Open wronglink opened this issue 8 years ago • 5 comments
trafficstars

It's hard to track new features and other pudb changes between releases. I think it would be nice to add CHANGELOG file in docs. Additionally its common practice to add CHANGELOG file contents to long_description in setup.py.

wronglink avatar May 03 '17 07:05 wronglink

There is a changelog, but it's in the source. Now that we have docs, it would be good to extract it to a place where it can be pulled in to both the docs and the PuDB UI.

asmeurer avatar May 03 '17 07:05 asmeurer

Oh, I see, it's over here: https://github.com/inducer/pudb/blob/master/pudb/debugger.py#L2107. I agree that the change should save ability to show changelog in the UI. I guess the best way would be to extract data CHANGELOG.rst in the root of package, add MANIFEST.in rules to provide it for UI level usage and copy it at documentation build stage, to make HTML version.

wronglink avatar May 03 '17 10:05 wronglink

I think you also have to add something to setup.py so that it gets installed.

asmeurer avatar May 03 '17 22:05 asmeurer

Any update? (I come here because my config file was overwritten by a new version of pudb)

sisrfeng avatar Feb 17 '22 12:02 sisrfeng

Oh, I see the changelog when I enter pudb

sisrfeng avatar Feb 17 '22 13:02 sisrfeng

This is outdated :

Oh, I see, it's over here: https://github.com/inducer/pudb/blob/master/pudb/debugger.py#L2107.

Just search Changes in version pudb/debugger.py.

sisrfeng avatar Feb 26 '24 09:02 sisrfeng