Ticket #9922 (new enhancement)

Opened 3 years ago

Last modified 21 months ago

Add release notes and VERSION.txt to SAGE_ROOT

Reported by: jhpalmieri Owned by: tbd
Priority: minor Milestone: sage-5.10
Component: distribution Keywords:
Cc: leif, mvngu Work issues:
Report Upstream: N/A Reviewers:
Authors: Merged in:
Dependencies: Stopgaps:

Description (last modified by jhpalmieri) (diff)

leif suggested at #9433 that we add two files to SAGE_ROOT:

  • a file containing release notes
  • a file VERSION.txt containing the version number

Perhaps the release notes could be produced using mvngu's  rnotes script (also available at  http://bitbucket.org/mvngu/rnotes/. We could in fact (with his permission) include that script with Sage, and then run it as part of the sage-sdist script. It might be better to not automate its creation, though.

The file VERSION.txt could at the very least just read from devel/sage/sage/version.py. Should it contain just the version number and the date? Whether it's a source or binary distribution? Whether it's been upgraded from an earlier version?

Change History

comment:1 Changed 3 years ago by jhpalmieri

  • Description modified (diff)
  • Summary changed from Add release notes to SAGE_ROOT to Add release notes and VERSION.txt to SAGE_ROOT

comment:2 Changed 3 years ago by leif

W.r.t. VERSION.txt: I think a single line containing the current version (perhaps also including "[last] upgraded from ...") in plain format should be sufficient; cf. also #9434 and local/bin/sage-banner.

comment:3 Changed 21 months ago by jhpalmieri

In sage-sdist, should we write VERSION.txt to SAGE_ROOT, or should we create a symlink to spkg/standard/VERSION.txt?

Note: See TracTickets for help on using tickets.