From 1b4d639c0bb27f78700fb140b5012bb227f291fd Mon Sep 17 00:00:00 2001 From: amercader Date: Fri, 13 Dec 2013 13:46:23 +0000 Subject: [PATCH] [#1389] Tweak release process docs --- doc/release-process.rst | 43 ++++++++++++----------------------------- 1 file changed, 12 insertions(+), 31 deletions(-) diff --git a/doc/release-process.rst b/doc/release-process.rst index 4b427d2cf03..9c7e9e9073d 100644 --- a/doc/release-process.rst +++ b/doc/release-process.rst @@ -26,17 +26,6 @@ become stable releases. You will probably need to update the same file on master to increase the version number, in this case ending with an *a* (for alpha). -#. Check if there have been changes in the |solr| schema at - ``ckan/config/solr/schema.xml``, and if so: - - * Update the ``version`` attribute of the ``schema`` with the current CKAN - version:: - - - - * Update the ``SUPPORTED_SCHEMA_VERSIONS`` list in - ``ckan/lib/search/__init__.py`` - #. During the beta process, all changes to the release branch must be cherry-picked from master (or merged from special branches based on the release branch if the original branch was not compatible). @@ -78,20 +67,12 @@ become stable releases. python setup.py extract_messages - d. Pull new and updated translations from Transifex into the ``ckan.po`` - files:: - - tx pull --all --force - The po files are text files, one for each language CKAN is translated to, that contain the translated strings next to the originals. Translators edit the po files (on Transifex) to update the translations. We never edit the po files locally. - ``--force`` tells Transifex to update all ``ckan.po`` files, regardless of the - modification time. - - e. Run our script that checks for mistakes in the ckan.po files:: + d. Run our script that checks for mistakes in the ckan.po files:: pip install polib paster check-po-files ckan/i18n/*/LC_MESSAGES/ckan.po @@ -100,11 +81,11 @@ become stable releases. tx pull command again, don't edit the files directly. Repeat until the script finds no mistakes. - f. Edit ``.tx/config``, on line 4 to set the Transifex 'resource' to the new + e. Edit ``.tx/config``, on line 4 to set the Transifex 'resource' to the new major release name (if different), using dashes instead of dots. For instance v1.2, v1.2.1 and v1.2.2 all share: ``[ckan.1-2]``. - g. Update the ``ckan.po`` files with the new strings from the ``ckan.pot`` file:: + f. Update the ``ckan.po`` files with the new strings from the ``ckan.pot`` file:: python setup.py update_catalog --no-fuzzy-matching @@ -115,7 +96,7 @@ become stable releases. We use the ``--no-fuzzy-matching`` option because fuzzy matching often causes problems with Babel and Transifex. - h. Create a new resource in the CKAN project on Transifex by pushing the new + g. Create a new resource in the CKAN project on Transifex by pushing the new pot and po files:: tx push --source --translations --force @@ -125,27 +106,27 @@ become stable releases. resource (updating an existing resource, especially with the ``--force`` option, can result in translations being deleted from Transifex). - i. Update the ``ckan.mo`` files by compiling the po files:: + h. Update the ``ckan.mo`` files by compiling the po files:: python setup.py compile_catalog The mo files are the files that CKAN actually reads when displaying strings to the user. - j. Commit all the above changes to git and push them to GitHub:: + i. Commit all the above changes to git and push them to GitHub:: - git commit -am " Update strings files before CKAN X.Y call for translations" + git commit -am "Update strings files before CKAN X.Y call for translations" git push - k. Announce that strings for the new release are ready for translators. Send + j. Announce that strings for the new release are ready for translators. Send an email to the mailing lists, tweet or post it on the blog. Make sure to post a link to the correct Transifex resource (like `this one `_) and tell users that they can register on Transifex to contribute. - l. A week before the translations will be closed send a reminder email. + k. A week before the translations will be closed send a reminder email. - m. Once the translations are closed, pull the updated strings from Transifex, + l. Once the translations are closed, pull the updated strings from Transifex, check them, compile and push as described in the previous steps:: tx pull --all --force @@ -219,7 +200,7 @@ a release. 8. Enable the new version of the docs on Read the Docs (you will need an admin account): - a. Go to the `versions page ` + a. Go to the `Read The Docs`_ versions page and enable the relevant release (make sure to use the tag, ie ckan-X.Y, not the branch, ie release-vX.Y). @@ -253,4 +234,4 @@ a release. .. _Transifex: https://www.transifex.com/projects/p/ckan -.. _ReadTheDocs: http://readthedocs.org/dashboard/ckan/versions/ +.. _`Read The Docs`: http://readthedocs.org/dashboard/ckan/versions/