Skip to content

[Documentation]: Improve & automate release notes to not rely on GitHub #712

@edwardchalstrey1

Description

@edwardchalstrey1

Requested documentation improvement

At the moment, the only place where Gambit releases with a changelog and downloadable source code are listed is on GitHub: https://github.com/gambitproject/gambit/releases - which annoyingly does not order the releases by version number.

It would be better if there was a releases docs page, however, we don't want to have to make updates in multiple places. So...

  • Research methods for automatically updating a releases docs page (and GitHub) from a single changelog markdown, or whatever best practice is - how do other packages handle this?
  • Implement that method and ensure the Making a new release section of the dev docs is updated with the new process
  • The new releases page should make download links very clear and it should be obvious to the user which one they want for their system and include link(s) to the Install page
  • Also update the Install page instructions to correctly links to the new releases page
  • Mention in the docs that Mac dmg needs to be signed and notatized, but don't explain how - see [Bug]: GUI cannot be installed on Mac via downloaded dmg #577 (comment)

Note: may be worth combining install and releases on a single page?

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions