This commit is part of a series to retire the Packaging Deb
project. Step 2 is to remove all content from the project
repos, replacing it with a README notification where to find
ongoing work, and how to recover the repo if needed at some
future point (as in
https://docs.openstack.org/infra/manual/drivers.html#retiring-a-project).
Change-Id: I4d66bc8da65514468dc5d56b9003a639b6f48ac8
After migrating to openstackdocstheme, there are several points
to be improved in the rendered HTML files.
* Cleanup unnecessary vertical lines for quote blocks.
Existing quote blocks are actually not intended and
leading extra spaces cause this.
This commit removes unnecessary leading spaces.
* Some quote blocks are converted into definition lists
to clean up vertical lines for quote blocks.
* Use code-block for better code highlighting.
* Specify maxdepth in user/index toctree.
Change-Id: I9add5a317718e97abce15b5ddbfa3d1208a01570
Convert note template to a format string. Also include prelude
section in the report generated and update docs.
Closes-Bug: #1698203
Change-Id: I7bef68bfb518dd8554d56cb200f2844e7d395fc8
The only places that this is called, we already have a
reno.config.Config instance available. Simply use that instead.
We also include a note of the 'conf.notespath' property, because the odd
behavior of this caught me out for a bit, and call 'os.path.normpath',
because the default path included redundant up-level references.
Change-Id: I58948cd8fad55d29bd30c65653630bd466259cdc
Not everyone wants to use build release notes separately from their main
documentation. For these users, having a 'notes' directory inside the
'releasenotes' directory is unnecessary. However, this also means we
must be able to move the config file out of the 'releasesnotes'
directory to avoid it being picked up as a release note.
Make this possible by adding support for a 'reno.yaml' file in the root
directory of the project.
Sadly it is not possible to apply this change to reno itself - doing so
would cause the files to be picked up as belonging to the current
release - but other projects can benefit from this.
Change-Id: Ie96103b85d70592dd766e5174784b992fe7782c5
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
When skipping null-merges, do not go back to the first parent node if we
have already processed it.
Fix a similar potential issue when handling parent nodes during regular
processing.
Change-Id: I10e531cdf3b203ca2e9249d89a37b61f79091311
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
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>
Add examples showing how sections that take lists of strings can also
include a single string, and expand on why the escaped rst formatting
works.
Change-Id: I26be8c3027aebbfb1bf4a6f17c6f995dc44aac1a
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Release notes entries may now be made up of single strings. This
simplifies formatting for smaller notes, and eliminates a class of
errors associated with escaping reStructuredText inside YAML lists.
Change-Id: I7f2fb2d2fd16f49e7ee061582df7bcdd4116f215
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>
Look through the other branches to find the previous branch and
determine where to stop scanning, instead of assuming the current branch
is the most recent and trying to artificially compute the previous
branch.
Change-Id: If905575a47c828ebe43e79a6c0f363eaa3226f6e
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
The aggregated change information for a deleted note includes the SHA as
well as the filename. Extract both from the tuple separately so the path
value is set correctly to a filename.
Change-Id: I41fb4a7a0f6d24af47c8f059945b9bf45f859f15
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
There is a build cycle between reno and oslosphinx. Now the
documentation can be build without oslosphinx installed.
Change-Id: Iae6abbe5b2991123f56bf2f4e852c57cd9ca6c11
Stop at the first version after the most recent branch was created,
instead of always only showing the most current version.
Change-Id: I58326c9e30349d2d7c473558b9aa2e8f7294c652
Closes-Bug: #1682147
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Sphinx 1.6.1 now interprets error and warning log messages as reasons to
abort the build when strict mode is enabled. Change the log level for
some calls that weren't really errors to begin with.
Change-Id: I688ee8b57e839ba6146633365be9ba8f92e3c7df
Closes-Bug: #1691224
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>
Prevent someone from adding multiple files with the same UID in the same
commit. Ignore any existing commits with the problem as long as there
was a later commit to delete the files.
Closes-Bug: #1688042
Change-Id: Id62361f3aba195417b369293e411c36172d27229
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Move _aggregate_changes() to a class so we can track state.
Related-Bug: #1688042
Change-Id: I23a7add3a65c65e74b8e5b7378031346fe2a75b3
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
When we find multiple files added with the same UID in one patch, ignore
them and emit a warning. That's bad input data, and we don't want to use
them.
Allow multiple files with the same UID to be deleted in a patch to
support cleaning up existing situations where the add case was not
caught properly.
Related-Bug: #1688042
Change-Id: I37fee0660ff541677d26770818764f7de2a2d863
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Comment out the governance badge link to avoid the warning from using a
remote image. This can be reverted when a version of pbr with the fix is
released.
Addresses-Bug: #1682467
Change-Id: I9caf5b22d075b4ff3f6be71e23a98f3b5044747c
Depends-On: If47e3ca6519cc9f70d62cd887707321fe9199f81
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
The gating on python 3.4 is restricted to <= Mitaka. This is due to
the change from Ubuntu Trusty to Xenial, where only python3.5 is
available. There is no need to continue to keep these settings.
Change-Id: Ia410cd56a57725aba1aad5e397e7915f1f773b6e
Add a ``--no-show-source`` option to the report command to skip
including the note reference file names and SHA information in comments
in the output. This restores the previous format of the output for cases
where it is meant to be read by people directly, not just converted to
HTML.
Change-Id: Ie284b8a8e60d5a5f958d229c5972e8d9bf697d44
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
The tests were passing unicode but in some cases the real code was
passing bytes, so accept both and do the encoding ourselves if we need
to.
Change-Id: I0f64d301b36207b1ffa6503e8c27f679cdf6516f
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Tony Breeds