search

xpdAcq / mission-control

Releases, Installers, Specs, and more!
0 stars 4 forks source link

Have a workflow about how release notes make it into the documentation #76

Closed sbillinge closed 6 years ago

sbillinge commented 6 years ago

make sure users (and managers) can (a) see the current release (b) quickly see what has changed from the previous release. This is most important for user-facing software

Expected Behavior

Every new release includes either automated or manual but following a prescribed protocol way of doing this.

Current Behavior

some changes are there, others are not. Just needs to be organized/formalized

Possible Solution

release checklist?

Steps to Reproduce (for bugs)

1. 2. 3.

Context

Priority

Your Environment

CJ-Wright commented 6 years ago

Rever has a tool for this. The basic idea is that we keep a news directory. Every time we put in some code this directory gets a new file added. When it comes time to release rever will put all the changes into a Changelog for us.

CJ-Wright commented 6 years ago

For example xonsh https://github.com/xonsh/xonsh/blob/master/news/alias-command.rst

CJ-Wright commented 6 years ago

I think we also need a link between the changelog rst file and something in the webdocs