Add release notes section to UPGRADING document. #987
Conversation
Pull Request Test Coverage Report for Build 1802
💛 - Coveralls |
| Release Notes | ||
| ------------- | ||
|
|
||
| 0.3 (Upcoming) |
There was a problem hiding this comment.
Upcoming is a bit vague to me. Maybe having an actual date?
There was a problem hiding this comment.
we don't really have an actual date. it's just as soon as we are done with all our issues marked with 0.3 milestone.
There was a problem hiding this comment.
Yeah, I'm just marking it this way so that it's obvious for someone reading on master that 0.3 hasn't happened yet. When we tag 0.3 we'll remove this, but we don't have a specific date for it (though it's looking like "soon").
There was a problem hiding this comment.
sure, am working on the version PR, which is the last PR for 0.3 milestones I believe
| * Validation checks for the configuration file have been added; be advised | ||
| that if there were errors in your ``hil.cfg`` that were previously | ||
| undetected you may need to fix them before the servers will start again | ||
| * The interface to the ``hil`` command line tool has changed substantially; |
There was a problem hiding this comment.
maybe we need to have an updated doc so we can point the readers to the relevant documentation?
There was a problem hiding this comment.
Hm, do we think just doing --help is enough to explore it? If so we could mention that. It looks like we also updated the existing docs re: CLI.
There was a problem hiding this comment.
I think just mentioning --help should be enough. We could probably, in the future, add some documentation about the CLI (even a man page for HIL man hil).
|
Some more things that might be useful to put in the changelog.
|
|
@naved001, added that list to the doc (with some slight wording changes & added references to docs). |
|
I am happy. |
docs/UPGRADING.rst
Outdated
| modified. | ||
| * URLs for API calls are now prefixed with a version number, which for the | ||
| current (unstable) API is ``v0``; you may need to update scripts and | ||
| settings accordingly (although the HIL tools themselves should remaining |
There was a problem hiding this comment.
typo: should remain internally consistent
docs/UPGRADING.rst
Outdated
| +++ | ||
|
|
||
| HaaS was renamed to HIL in this release. Accordingly, there are several | ||
| changess that need to be made when upgrading: |
Thanks to Naved for spotting these.
|
@Naved, fixed. |
|
not sure if we should merge it now, or after the last PR for 0.3 is merged? |
|
I don't see any reason not to do so now.
Quoting Naved Ansari (2018-04-03 17:47:13)
… not sure if we should merge it now, or after the last PR for 0.3 is
merged?
|
Fixes #865
Note that the 0.3 section is not necessarily complete; I added stuff I could think of off the top of my head, and skimmed the closed issues on the 0.3 milestone (where I didn't find anything that seemed like it needed mentioning).