Added --push-remote CLI option.

Adding option so users can specify which remote to push to. This is
handy in case the remote hosting HTML files is a bare repo on a web
host.

Copying all remotes and all fetch/push URLs to the cloned repo when
using push().

Author: Robpol86

.travis.yml

@@ -21,7 +21,7 @@ after_success:
   - eval "$(ssh-agent -s)"; touch docs/key; chmod 0600 docs/key
   - openssl aes-256-cbc -d -K "$encrypted_9c2bf3fbb9ea_key" -iv "$encrypted_9c2bf3fbb9ea_iv" < docs/key.enc > docs/key
     && ssh-add docs/key
-  - git remote set-url origin "[email protected]:$TRAVIS_REPO_SLUG"
+  - git remote set-url --push origin "[email protected]:$TRAVIS_REPO_SLUG"
   - export ${!TRAVIS*}
   - tox -e docsV
 

README.rst

@@ -47,8 +47,12 @@ This project adheres to `Semantic Versioning <http://semver.org/>`_.
 Unreleased
 ----------
 
+Added
+    * Command line option: ``--push-remote``
+
 Fixed
-    * Carrying over to cloned repo the git remote push URL if it's different from fetch URL.
+    * Copy all remotes from the original repo to the temporarily cloned repo when pushing built docs to a remote.
+      Carries over all remote URLs in case user defines a different URL for push vs fetch.
 
 2.1.0 - 2016-08-22
 ------------------

docs/github_pages.rst

@@ -130,7 +130,7 @@ section look like this:
         && ssh-add docs/key  # Use && to prevent ssh-add from prompting during pull requests.
       - git config --global user.email "[email protected]"
       - git config --global user.name "Travis CI"
-      - git remote set-url origin "[email protected]:$TRAVIS_REPO_SLUG"
+      - git remote set-url --push origin "[email protected]:$TRAVIS_REPO_SLUG"
       - export ${!TRAVIS*}  # Optional, for commit messages.
       - sphinx-versioning push docs gh-pages .
 

docs/settings.rst

@@ -277,7 +277,7 @@ Push Arguments
 three times in case of race conditions with other processes also trying to push files to the same branch (e.g. multiple
 Jenkins/Travis jobs).
 
-HTML files are committed to :option:`DEST_BRANCH` and pushed to origin.
+HTML files are committed to :option:`DEST_BRANCH` and pushed to :option:`--push-remote`.
 
 Positional Arguments
 --------------------
@@ -286,10 +286,11 @@ In addition to the :ref:`common arguments <common-positional-arguments>`:
 
 .. option:: DEST_BRANCH
 
-    The branch name where generated docs will be committed to. The branch will then be pushed to origin. If there is a
-    race condition with another job pushing to origin the docs will be re-generated and pushed again.
+    The branch name where generated docs will be committed to. The branch will then be pushed to the remote specified in
+    :option:`--push-remote`. If there is a race condition with another job pushing to the remote the docs will be
+    re-generated and pushed again.
 
-    This must be a branch and not a tag. This also must already exist in origin.
+    This must be a branch and not a tag. This also must already exist in the remote.
 
 .. option:: REL_DEST
 
@@ -320,3 +321,13 @@ only for the push sub command:
     .. code-block:: python
 
         scv_grm_exclude = ('README.md', '.gitignore')
+
+.. option:: -P <remote>, --push-remote <remote>, scv_push_remote
+
+    Push built docs to this remote. Default is **origin**.
+
+    This setting may also be specified in your conf.py file. It must be a string:
+
+    .. code-block:: python
+
+        scv_push_remote = 'origin2'

sphinxcontrib/versioning/__main__.py

@@ -121,8 +121,8 @@ def get_params(self, ctx):
 def cli(config, **options):
     """Build versioned Sphinx docs for every branch and tag pushed to origin.
 
-    Supports only building locally with the "build" sub command or build and push to origin with the "push" sub command.
-    For more information for either run them with their own --help.
+    Supports only building locally with the "build" sub command or build and push to a remote with the "push" sub
+    command. For more information for either run them with their own --help.
 
     The options below are global and must be specified before the sub command name (e.g. -N build ...).
     \f
@@ -319,6 +319,7 @@ def build(config, rel_source, destination, **options):
 @click.option('-e', '--grm-exclude', multiple=True,
               help='If specified "git rm" will delete all files in REL_DEST except for these. Specify multiple times '
                    'for more. Paths are relative to REL_DEST in DEST_BRANCH.')
+@click.option('-P', '--push-remote', help='Push built docs to this remote. Default is origin.')
 @click.argument('REL_SOURCE', nargs=-1, required=True)
 @click.argument('DEST_BRANCH')
 @click.argument('REL_DEST')
@@ -333,8 +334,8 @@ def push(ctx, config, rel_source, dest_branch, rel_dest, **options):
     REL_SOURCE is the path to the docs directory relative to the git root. If the source directory has moved around
     between git tags you can specify additional directories.
 
-    DEST_BRANCH is the branch name where generated docs will be committed to. The branch will then be pushed to origin.
-    If there is a race condition with another job pushing to origin the docs will be re-generated and pushed again.
+    DEST_BRANCH is the branch name where generated docs will be committed to. The branch will then be pushed to remote.
+    If there is a race condition with another job pushing to remote the docs will be re-generated and pushed again.
 
     REL_DEST is the path to the directory that will hold all generated docs for all versions relative to the git roof of
     DEST_BRANCH.
@@ -376,7 +377,7 @@ def push(ctx, config, rel_source, dest_branch, rel_dest, **options):
 
             log.info('Attempting to push to branch %s on remote repository.', dest_branch)
             try:
-                if commit_and_push(temp_dir, versions):
+                if commit_and_push(temp_dir, config.push_remote, versions):
                     return
             except GitError as exc:
                 log.error(exc.message)

sphinxcontrib/versioning/git.py

@@ -11,7 +11,7 @@
 
 from sphinxcontrib.versioning.lib import TempDir
 
-RE_FETCH_PUSH = re.compile(r'origin\t([A-Za-z0-9@:/._-]+) \((fetch|push)\)\n')
+RE_ALL_REMOTES = re.compile(r'([\w./-]+)\t([A-Za-z0-9@:/._-]+) \((fetch|push)\)\n')
 RE_REMOTE = re.compile(r'^(?P<sha>[0-9a-f]{5,40})\trefs/(?P<kind>heads|tags)/(?P<name>[\w./-]+(?:\^\{})?)$',
                        re.MULTILINE)
 RE_UNIX_TIME = re.compile(r'^\d{10}$', re.MULTILINE)
@@ -313,14 +313,18 @@ def clone(local_root, new_root, branch, rel_dest, exclude):
     """
     log = logging.getLogger(__name__)
     output = run_command(local_root, ['git', 'remote', '-v'])
-    remote_urls = dict((m[1], m[0]) for m in RE_FETCH_PUSH.findall(output))
-    if not remote_urls:
+    matches = RE_ALL_REMOTES.findall(output)
+    if not matches:
+        raise GitError('Git repo has no remotes.', output)
+    remotes = {m[0]: [m[1], ''] for m in matches if m[2] == 'fetch'}
+    for match in (m for m in matches if m[2] == 'push'):
+        remotes[match[0]][1] = match[1]
+    if 'origin' not in remotes:
         raise GitError('Git repo missing remote "origin".', output)
-    remote_push_url, remote_fetch_url = remote_urls['push'], remote_urls['fetch']
 
     # Clone.
     try:
-        run_command(new_root, ['git', 'clone', remote_fetch_url, '--depth=1', '--branch', branch, '.'])
+        run_command(new_root, ['git', 'clone', remotes['origin'][0], '--depth=1', '--branch', branch, '.'])
     except CalledProcessError as exc:
         raise GitError('Failed to clone from remote repo URL.', exc.output)
 
@@ -330,9 +334,11 @@ def clone(local_root, new_root, branch, rel_dest, exclude):
     except CalledProcessError as exc:
         raise GitError('Specified branch is not a real branch.', exc.output)
 
-    # Set push URL if different.
-    if remote_fetch_url != remote_push_url:
-        run_command(new_root, ['git', 'remote', 'set-url', '--push', 'origin', remote_push_url])
+    # Copy all remotes from original repo.
+    for name, (fetch, push) in remotes.items():
+        if name != 'origin':
+            run_command(new_root, ['git', 'remote', 'add', name, fetch])
+        run_command(new_root, ['git', 'remote', 'set-url', '--push', name, push])
 
     # Done if no exclude.
     if not exclude:
@@ -355,13 +361,14 @@ def clone(local_root, new_root, branch, rel_dest, exclude):
     run_command(new_root, ['git', 'checkout', '--'] + exclude_joined)
 
 
-def commit_and_push(local_root, versions):
-    """Commit changed, new, and deleted files in the repo and attempt to push the branch to origin.
+def commit_and_push(local_root, remote, versions):
+    """Commit changed, new, and deleted files in the repo and attempt to push the branch to the remote repository.
 
     :raise CalledProcessError: Unhandled git command failure.
     :raise GitError: Conflicting changes made in remote by other client and bad git config for commits.
 
     :param str local_root: Local path to git root directory.
+    :param str remote: The git remote to push to.
     :param sphinxcontrib.versioning.versions.Versions versions: Versions class instance.
 
     :return: If push succeeded.
@@ -410,7 +417,7 @@ def commit_and_push(local_root, versions):
 
     # Push.
     try:
-        run_command(local_root, ['git', 'push', 'origin', current_branch])
+        run_command(local_root, ['git', 'push', remote, current_branch])
     except CalledProcessError as exc:
         if '[rejected]' in exc.output and '(fetch first)' in exc.output:
             log.debug('Remote has changed since cloning the repo. Must retry.')

sphinxcontrib/versioning/lib.py

@@ -34,6 +34,7 @@ def __init__(self):
         self.git_root = None
         self.local_conf = None
         self.priority = None
+        self.push_remote = 'origin'
         self.root_ref = 'master'
 
         # Tuples.

tests/test__main__/test_arguments.py

@@ -215,9 +215,10 @@ def test_sub_command_options(local_empty, push, source_cli, source_conf):
 
     # Setup source(s).
     if source_cli:
-        args += ['-aAbitT', '-B', 'x', '-p', 'branches', '-r', 'feature', '-s', 'semver', '-w', 'master', '-W', '[0-9]']
+        args += ['-itT', '-p', 'branches', '-r', 'feature', '-s', 'semver', '-w', 'master', '-W', '[0-9]']
+        args += ['-aAb', '-B', 'x']
         if push:
-            args += ['-e' 'README.md']
+            args += ['-e' 'README.md', '-P', 'rem']
     if source_conf:
         local_empty.ensure('docs', 'contents.rst')
         local_empty.ensure('docs', 'conf.py').write(
@@ -228,6 +229,7 @@ def test_sub_command_options(local_empty, push, source_cli, source_conf):
             'scv_greatest_tag = True\n'
             'scv_invert = True\n'
             'scv_priority = "tags"\n'
+            'scv_push_remote = "origin2"\n'
             'scv_recent_tag = True\n'
             'scv_root_ref = "other"\n'
             'scv_show_banner = True\n'
@@ -257,6 +259,7 @@ def test_sub_command_options(local_empty, push, source_cli, source_conf):
         assert config.whitelist_tags == ('[0-9]',)
         if push:
             assert config.grm_exclude == ('README.md',)
+            assert config.push_remote == 'rem'
     elif source_conf:
         assert config.banner_greatest_tag is True
         assert config.banner_main_ref == 'y'
@@ -272,6 +275,7 @@ def test_sub_command_options(local_empty, push, source_cli, source_conf):
         assert config.whitelist_tags.pattern == '^[0-9]$'
         if push:
             assert config.grm_exclude == ('README.rst',)
+            assert config.push_remote == 'origin2'
     else:
         assert config.banner_greatest_tag is False
         assert config.banner_main_ref == 'master'
@@ -287,6 +291,7 @@ def test_sub_command_options(local_empty, push, source_cli, source_conf):
         assert config.whitelist_tags == tuple()
         if push:
             assert config.grm_exclude == tuple()
+            assert config.push_remote == 'origin'
 
 
 @pytest.mark.parametrize('push', [False, True])

tests/test__main__/test_main_push_scenarios.py

@@ -164,6 +164,43 @@ def test_race(tmpdir, local_docs_ghp, remote, run, urls, give_up):
     assert actual == 'Orphaned branch for HTML docs.changed'
 
 
+def test_second_remote(tmpdir, local_docs_ghp, run, urls):
+    """Test pushing to a non-origin remote.
+
+    :param tmpdir: pytest fixture.
+    :param local_docs_ghp: conftest fixture.
+    :param run: conftest fixture.
+    :param urls: conftest fixture.
+    """
+    # Error out because origin2 doesn't exist yet.
+    with pytest.raises(CalledProcessError) as exc:
+        run(local_docs_ghp, ['sphinx-versioning', 'push', '.', 'gh-pages', '.', '-P', 'origin2'])
+    assert 'Traceback' not in exc.value.output
+    assert 'Failed to push to remote.' in exc.value.output
+    assert "fatal: 'origin2' does not appear to be a git repository" in exc.value.output
+
+    # Create origin2.
+    origin2 = tmpdir.ensure_dir('origin2')
+    run(origin2, ['git', 'init', '--bare'])
+    run(local_docs_ghp, ['git', 'remote', 'add', 'origin2', origin2])
+    run(local_docs_ghp, ['git', 'push', 'origin2', 'gh-pages'])
+
+    # Run again.
+    output = run(local_docs_ghp, ['sphinx-versioning', 'push', '.', 'gh-pages', '.', '-P', 'origin2'])
+    assert 'Traceback' not in output
+    assert 'Successfully pushed to remote repository.' in output
+
+    # Check files.
+    run(local_docs_ghp, ['git', 'checkout', 'origin2/gh-pages'])
+    run(local_docs_ghp, ['git', 'pull', 'origin2', 'gh-pages'])
+    urls(local_docs_ghp.join('contents.html'), ['<li><a href="master/contents.html">master</a></li>'])
+    urls(local_docs_ghp.join('master', 'contents.html'), ['<li><a href="contents.html">master</a></li>'])
+    run(local_docs_ghp, ['git', 'checkout', 'origin/gh-pages'])
+    run(local_docs_ghp, ['git', 'pull', 'origin', 'gh-pages'])
+    assert not local_docs_ghp.join('contents.html').check()
+    assert not local_docs_ghp.join('master').check()
+
+
 def test_error_clone_failure(local_docs, run):
     """Test DEST_BRANCH doesn't exist.
 
@@ -221,8 +258,13 @@ def test_bad_git_config(local_docs_ghp, run):
                 # Invalidate lock file.
                 tmp_repo = py.path.local(re.findall(r'"cwd": "([^"]+)"', line.decode('utf-8'))[0])
                 assert tmp_repo.check(dir=True)
-                run(tmp_repo, ['git', 'config', 'user.useConfigOnly', 'true'])
-                run(tmp_repo, ['git', 'config', 'user.email', '(none)'])
+                for _ in range(3):
+                    try:
+                        run(tmp_repo, ['git', 'config', 'user.useConfigOnly', 'true'])
+                        run(tmp_repo, ['git', 'config', 'user.email', '(none)'])
+                    except CalledProcessError:
+                        continue
+                    break
                 caused = True
     output_lines.append(proc.communicate()[0])
     output = b''.join(output_lines).decode('utf-8')

tests/test_git/test_clone.py

@@ -147,11 +147,19 @@ def test_bad_branch_rel_dest_exclude(tmpdir, local, run):
         clone(str(local), str(tmpdir.ensure_dir('new_root3')), 'master', 'unknown', ['README'])
     assert "pathspec 'unknown' did not match any files" in exc.value.output
 
-    # No remote.
-    run(local, ['git', 'remote', 'rm', 'origin'])
+    # No origin.
+    run(local, ['git', 'remote', 'rename', 'origin', 'origin2'])
     with pytest.raises(GitError) as exc:
         clone(str(local), str(tmpdir.ensure_dir('new_root3')), 'master', '.', None)
     assert 'Git repo missing remote "origin".' in exc.value.message
+    assert 'origin2\t' in exc.value.output
+    assert 'origin\t' not in exc.value.output
+
+    # No remote.
+    run(local, ['git', 'remote', 'rm', 'origin2'])
+    with pytest.raises(GitError) as exc:
+        clone(str(local), str(tmpdir.ensure_dir('new_root3')), 'master', '.', None)
+    assert 'Git repo has no remotes.' in exc.value.message
     assert not exc.value.output
 
     # Bad remote.
@@ -161,21 +169,33 @@ def test_bad_branch_rel_dest_exclude(tmpdir, local, run):
     assert "repository '{}' does not exist".format(local.join('does_not_exist')) in exc.value.output
 
 
-def test_fetch_push_remotes(tmpdir, local, remote, run):
-    """Test different fetch/push URLs being carried over.
+def test_multiple_remotes(tmpdir, local, remote, run):
+    """Test multiple remote URLs being carried over.
 
     :param tmpdir: pytest fixture.
     :param local: conftest fixture.
     :param remote: conftest fixture.
     :param run: conftest fixture.
     """
-    remote_push = tmpdir.ensure_dir('remote_push')
-    run(remote_push, ['git', 'init', '--bare'])
-    run(local, ['git', 'remote', 'set-url', '--push', 'origin', str(remote_push)])
+    origin_push = tmpdir.ensure_dir('origin_push')
+    run(origin_push, ['git', 'init', '--bare'])
+    run(local, ['git', 'remote', 'set-url', '--push', 'origin', str(origin_push)])
+    origin2_fetch = tmpdir.ensure_dir('origin2_fetch')
+    run(origin2_fetch, ['git', 'init', '--bare'])
+    run(local, ['git', 'remote', 'add', 'origin2', str(origin2_fetch)])
+    origin2_push = tmpdir.ensure_dir('origin2_push')
+    run(origin2_push, ['git', 'init', '--bare'])
+    run(local, ['git', 'remote', 'set-url', '--push', 'origin2', str(origin2_push)])
 
     new_root = tmpdir.ensure_dir('new_root')
     clone(str(local), str(new_root), 'master', '', None)
 
     output = run(new_root, ['git', 'remote', '-v'])
-    expected = 'origin\t{} (fetch)\norigin\t{} (push)\n'.format(remote, remote_push)
-    assert output == expected
+    actual = output.strip().splitlines()
+    expected = [
+        'origin\t{} (fetch)'.format(remote),
+        'origin\t{} (push)'.format(origin_push),
+        'origin2\t{} (fetch)'.format(origin2_fetch),
+        'origin2\t{} (push)'.format(origin2_push),
+    ]
+    assert actual == expected