diff --git a/doc/RELEASE.md b/doc/RELEASE.md new file mode 100644 index 000000000..988169cee --- /dev/null +++ b/doc/RELEASE.md @@ -0,0 +1,77 @@ +# Release Build Instructions + +## Generate Coverage Report + +These instructions are temporary until a fully automated report is implemented. + +- In `test/src/lcov.conf` remove: +``` + # Specify the regular expression of lines to exclude + lcov_excl_line=\{\+*uncovered|\{\+*uncoverable + + # Coverage rate limits + genhtml_hi_limit = 100 + genhtml_med_limit = 90 +``` + +- In `test/lib/pgBackRestTest/Common/JobTest.pm` modify: +``` +if (!$bTest || $iTotalLines != $iCoveredLines || $iTotalBranches != $iCoveredBranches) +``` +to: +``` +if (!$bTest) +``` + +- Run: +``` +/backrest/test/test.pl --dev-test --vm=u18 --c-only +``` + +- Copy coverage report: +``` +cd doc/site +cp -r ../../test/coverage/c coverage +``` + +- In `doc/site/coverage` replace: +``` + LCOV - all.lcov +``` +with: +``` + pgBackRest vX.XX C Code Coverage +``` + +- In `doc/site/coverage` replace: +``` + LCOV - code coverage report +``` +with: +``` + pgBackRest vX.XX C Code Coverage +``` + +- In `doc/site/coverage` replace: +``` + LCOV - all.lcov - +``` +with: +``` + <title>pgBackRest vX.XX C Code Coverage - +``` + +- In `doc/site/coverage` replace: +``` + <td class="headerValue">all C unit</td> +``` +with: +``` + <td class="headerValue">all C unit</td> +``` + +- Switch to prior dir and copy coverage: +``` +doc/site/prior/X.XX +cp -r ../../coverage . +``` diff --git a/doc/xml/release.xml b/doc/xml/release.xml index b4ec407dc..2129cfde6 100644 --- a/doc/xml/release.xml +++ b/doc/xml/release.xml @@ -38,6 +38,14 @@ </release-item> </release-development-list> </release-core-list> + + <release-doc-list> + <release-development-list> + <release-item> + <p>Add instructions for building the coverage report.</p> + </release-item> + </release-development-list> + </release-doc-list> </release> <release date="2019-02-09" version="2.10" title="Bug Fixes">