The use of https and some of them are http.
Use https instead of http to ensure the safety without containing our
account/password information.
e.g. https://review.openstack.org/#/c/462890/
Change-Id: I545833e4d7ede4435e4f50bed792a60847e9a813
Make it easier to produce clean release notes by ignoring files
mistakenly edited on the wrong branch.
Change-Id: I74fb9e6c74af0b9de8cfe0d9c07ecfbd09cae925
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
OpenStack used to use null-merges to bring final release tags from
stable branches back into the master branch. This confuses the regular
traversal because it makes that stable branch appear to be part of
master and/or the later stable branch. Update the scanner so that when
it hit one of those merge commits, it skips it and take the first parent
so it continues to traverse the branch being scanned.
Change-Id: I90722a3946f691e8f58a52e68ee455d6530f047a
Closes-Bug: #1695057
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Provide a tool for doing some basic input validation.
Related-Bug: #1688042
Change-Id: I850b57153c5286e19f4ac3af899b3d798aebd7d4
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
The list of section identifiers and corresponding display names, and the
order in which they are rendered, was hard-coded. Some projects want to
customise this, so move it into the Config object so that it can now be
specified via config.yaml, e.g.
sections:
- [features, New Features]
- [issues, Known Issues]
- [upgrade, Upgrade Notes]
- [api, API Changes]
- [security, Security Issues]
- [fixes, Bug Fixes]
Change-Id: I914572c6a07ca81c54965b4b5a6b6aba50b3a787
The configuration file has to be named config.yaml, so fix the
documentation not to refer to config.yml.
Change-Id: Icb2ef9f99a043a4e9a460f984436dcfdbe0cb41b
Expand the readme to include more description of the benefits of using
reno.
Clean up the organization in index.rst.
Remove an unused readme.rst from within the documentation tree --
nothing imported it or linked to it.
Clean up phrasing and formatting in the usage page.
Change-Id: Id3f0b71f199f7ad15d5fc0b3df67e05b7a8f2b19
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Commonly, we edit a note just after its creation with reno new command.
This change enables to do both with reno new --edit, it creates a new
note and edits it with your editor (defined with EDITOR env variable).
Change-Id: I7866277c8ceaae41b9b9d0225ee33dcc37f3be6b
Currently the template used to create new notes is hardcoded in reno
source code. It's fine when reno is used inside OpenStack community but
external projects would perhaps like to use a custom template in order
to better match their needs.
This change supports to set through "template" attribute in config.yaml
a custom template which will be used by reno new to create new notes.
Change-Id: I83a870eb9906c26e5ee946d53b9c154867180971
The previous commit changes the default behavior to always stop scanning
at the base of a branch. This change adds a configuration option to
allow that behavior to be disabled, so that revisions along the history
of the branch prior to the point where it diverged from master can be
included. The new default behavior established in the previous commit is
not changed.
Change-Id: I2c4968e1291c1b7d268896cfbb79e320d4085bce
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
We do not want to put instructions that are specific to OpenStack in a
general-purpose tool, but it's OK to link to those instructions
elsewhere since a lot of people will start by looking at the reno
documentation.
Change-Id: I73f9fd71cfc24d67420adb70509a2775ad022627
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
code-block on its own will surpress the argument, add console so that
the next line gets displayed. Also add "$" to signify the command line
interaction.
Change-Id: I2107356a1063f7f7e1c5c68ef821aebe2897969d
Adds a 'debugging' section to the usage documentation, with a quick note
to help users uncover errors masked by sphinx includes.
Change-Id: I9c24931c3acb0ab7588221f278287549eee0b3cd
While discussing I7539fdeada14a73ae4e18a125bb0e3947f08e8d1 Doug and
Harry realized that it would be much better if some of these values
could be specified in a config file, whether INI or YAML.
This adds a simple function to allow options to be specified in the
config file named "config.yml" in the --rel-notes-dir.
Change-Id: Ie25e1eb3da66cc627d93af585b0893469d6a7b2e
Set up an example directory to hold example notes and add one showing
how to use complex formatting.
Change-Id: I7b3e27c394789cc1ff832ca0bf26f3244b058eb7
Doug Hellmann