From ce50916ec586d381c9016f441f49bef66e9d020f Mon Sep 17 00:00:00 2001 From: Sajith Sasidharan Date: Mon, 4 Jan 2021 20:21:43 -0500 Subject: [PATCH 1/9] Add newsfragment --- newsfragments/3536.minor | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 newsfragments/3536.minor diff --git a/newsfragments/3536.minor b/newsfragments/3536.minor new file mode 100644 index 000000000..e69de29bb From 57282d243111043aaa392f8a2edb5daa1c0749ea Mon Sep 17 00:00:00 2001 From: Sajith Sasidharan Date: Mon, 4 Jan 2021 20:38:44 -0500 Subject: [PATCH 2/9] Include contribution guidelines for real This warning should go away with this commit: WARNING: toctree contains reference to nonexisting document u'.github/CONTRIBUTING' --- docs/contributing.rst | 1 + docs/index.rst | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 docs/contributing.rst diff --git a/docs/contributing.rst b/docs/contributing.rst new file mode 100644 index 000000000..15e1b6432 --- /dev/null +++ b/docs/contributing.rst @@ -0,0 +1 @@ +.. include:: ../.github/CONTRIBUTING.rst diff --git a/docs/index.rst b/docs/index.rst index 3d0a41302..e5db73db0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,7 +23,7 @@ Contents: frontends/download-status known_issues - ../.github/CONTRIBUTING + contributing CODE_OF_CONDUCT servers From 97454242354072619988ead4067df537952b8b08 Mon Sep 17 00:00:00 2001 From: Sajith Sasidharan Date: Mon, 4 Jan 2021 20:44:13 -0500 Subject: [PATCH 3/9] Include release checklist --- docs/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/index.rst b/docs/index.rst index e5db73db0..60a3aa5d4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -25,6 +25,7 @@ Contents: known_issues contributing CODE_OF_CONDUCT + release-checklist servers helper From d0859b11017a7e049df94b509dda123db06828d0 Mon Sep 17 00:00:00 2001 From: Sajith Sasidharan Date: Mon, 4 Jan 2021 21:04:13 -0500 Subject: [PATCH 4/9] Fix indentation in webapi docs Warning was: tahoe-lafs/docs/frontends/webapi.rst:2035: WARNING: Unexpected indentation. --- docs/frontends/webapi.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/frontends/webapi.rst b/docs/frontends/webapi.rst index 99fa44979..e00445fbf 100644 --- a/docs/frontends/webapi.rst +++ b/docs/frontends/webapi.rst @@ -2032,10 +2032,11 @@ potential for surprises when the file store structure is changed. Tahoe-LAFS provides a mutable file store, but the ways that the store can change are limited. The only things that can change are: - * the mapping from child names to child objects inside mutable directories - (by adding a new child, removing an existing child, or changing an - existing child to point to a different object) - * the contents of mutable files + +* the mapping from child names to child objects inside mutable directories + (by adding a new child, removing an existing child, or changing an + existing child to point to a different object) +* the contents of mutable files Obviously if you query for information about the file store and then act to change it (such as by getting a listing of the contents of a mutable From 4e56cc6d379c35b8a2d479b665b35756279be41b Mon Sep 17 00:00:00 2001 From: Sajith Sasidharan Date: Mon, 4 Jan 2021 21:19:40 -0500 Subject: [PATCH 5/9] Fix nested bullet lists in release checklist doc --- docs/release-checklist.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/release-checklist.rst b/docs/release-checklist.rst index be32aea6c..da692ef61 100644 --- a/docs/release-checklist.rst +++ b/docs/release-checklist.rst @@ -40,23 +40,31 @@ Create Branch and Apply Updates - Create a branch for release-candidates (e.g. `XXXX.release-1.15.0.rc0`) - run `tox -e news` to produce a new NEWS.txt file (this does a commit) - create the news for the release + - newsfragments/.minor - commit it + - manually fix NEWS.txt + - proper title for latest release ("Release 1.15.0" instead of "Release ...post1432") - double-check date (maybe release will be in the future) - spot-check the release notes (these come from the newsfragments files though so don't do heavy editing) - commit these changes + - update "relnotes.txt" + - update all mentions of 1.14.0 -> 1.15.0 - update "previous release" statement and date - summarize major changes - commit it + - update "CREDITS" + - are there any new contributors in this release? - one way: git log release-1.14.0.. | grep Author | sort | uniq - commit it + - update "docs/known_issues.rst" if appropriate - update "docs/INSTALL.rst" references to the new release - Push the branch to github @@ -82,21 +90,32 @@ they will need to evaluate which contributors' signatures they trust. - (all steps above are completed) - sign the release + - git tag -s -u 0xE34E62D06D0E69CFCA4179FFBDE0D31D68666A7A -m "release Tahoe-LAFS-1.15.0rc0" tahoe-lafs-1.15.0rc0 - (replace the key-id above with your own) + - build all code locally - these should all pass: + - tox -e py27,codechecks,docs,integration + - these can fail (ideally they should not of course): + - tox -e deprecations,upcoming-deprecations + - build tarballs + - tox -e tarballs - confirm it at least exists: - ls dist/ | grep 1.15.0rc0 + - inspect and test the tarballs + - install each in a fresh virtualenv - run `tahoe` command + - when satisfied, sign the tarballs: + - gpg --pinentry=loopback --armor --sign dist/tahoe_lafs-1.15.0rc0-py2-none-any.whl - gpg --pinentry=loopback --armor --sign dist/tahoe_lafs-1.15.0rc0.tar.bz2 - gpg --pinentry=loopback --armor --sign dist/tahoe_lafs-1.15.0rc0.tar.gz @@ -129,6 +148,7 @@ need to be uploaded to https://tahoe-lafs.org in `~source/downloads` https://tahoe-lafs.org/downloads/ on the Web. - scp dist/*1.15.0* username@tahoe-lafs.org:/home/source/downloads - the following developers have access to do this: + - exarkun - meejah - warner @@ -139,6 +159,7 @@ uploaded to PyPI as well. - how to do this? - (original guide says only "twine upload dist/*") - the following developers have access to do this: + - warner - exarkun (partial?) - meejah (partial?) From 1063ee1c1f222276341b4596161455f4f9a7668b Mon Sep 17 00:00:00 2001 From: Sajith Sasidharan Date: Mon, 4 Jan 2021 21:21:43 -0500 Subject: [PATCH 6/9] Fix warning in release checklist doc Fix "WARNING: Inline emphasis start-string without end-string." --- docs/release-checklist.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release-checklist.rst b/docs/release-checklist.rst index da692ef61..fabb69fc7 100644 --- a/docs/release-checklist.rst +++ b/docs/release-checklist.rst @@ -157,7 +157,7 @@ For the actual release, the tarball and signature files need to be uploaded to PyPI as well. - how to do this? -- (original guide says only "twine upload dist/*") +- (original guide says only `twine upload dist/*`) - the following developers have access to do this: - warner From f1cf9483566ae719d605df7754630e68fdb6f77f Mon Sep 17 00:00:00 2001 From: Sajith Sasidharan Date: Fri, 8 Jan 2021 13:45:16 -0500 Subject: [PATCH 7/9] Enable markdown support in Sphinx configuration The upstream Contributor Covenant is a markdown document. Since we prefer to keep things close to the original, enabling markdown support to render that document seems like a good idea. --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 34ddd1bd4..612c324a3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -28,7 +28,7 @@ import os # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [] +extensions = ['recommonmark'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -36,7 +36,7 @@ templates_path = ['_templates'] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # source_suffix = ['.rst', '.md'] -source_suffix = '.rst' +source_suffix = ['.rst', '.md'] # The encoding of source files. #source_encoding = 'utf-8-sig' From 65926d6e708b967759b1ad50999bb84ff05c13d2 Mon Sep 17 00:00:00 2001 From: Sajith Sasidharan Date: Fri, 8 Jan 2021 13:48:04 -0500 Subject: [PATCH 8/9] Install recommonmark in tox "docs" environment We're going to need markdown support to render contributor covenant. --- tox.ini | 1 + 1 file changed, 1 insertion(+) diff --git a/tox.ini b/tox.ini index c61331885..d32f90b15 100644 --- a/tox.ini +++ b/tox.ini @@ -211,6 +211,7 @@ commands = deps = sphinx docutils==0.12 + recommonmark # normal install is not needed for docs, and slows things down skip_install = True commands = From f682d946d0ffffaf1f05d1b9157a83faea84ee5d Mon Sep 17 00:00:00 2001 From: Sajith Sasidharan Date: Fri, 8 Jan 2021 13:48:23 -0500 Subject: [PATCH 9/9] Rename docs/README.md After enabling markdown extension in Sphinx configuration, there's a warning about docs/README.md not being included in the toc tree. Since docs/README.md is not to be included in the final rendered document, we'll keep it as a .txt document. --- docs/{README.md => README.txt} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{README.md => README.txt} (100%) diff --git a/docs/README.md b/docs/README.txt similarity index 100% rename from docs/README.md rename to docs/README.txt