Specify new behavior in documentation

Author: nbedos

CHANGELOG.md

@@ -1,15 +1,19 @@
 # Changelog
 
+## Next version
+
+* Feature: Monitor all remotes of local repositories instead of just 'origin' ([issue #3](https://github.com/nbedos/citop/issues/3))
+
 
 ## Version 0.1.2 (2019-12-20)
 
-* Fix: Binary releases now contain an executable built for the right system (#4)
+* Fix: Binary releases now contain an executable built for the right system ([issue #4](https://github.com/nbedos/citop/issues/4))
 * Fix: Appveyor pipelines triggered for a tag incorrectly showed a branch as reference instead of a tag
 
 
 ## Version 0.1.1 (2019-12-18)
 
-* Support for private GitLab instances [#2]
+* Support for private GitLab instances ([issue #2](https://github.com/nbedos/citop/issues/2))
 
 
 ## Version 0.1.0 (2019-12-18)

README.md

@@ -119,14 +119,14 @@ Positional arguments:
 
 Options:
   -r REPOSITORY, --repository REPOSITORY
-                Specify the git repository to work with. REPOSITORY can
-                be either a path to a local git repository, or the URL
-                of an online repository hosted at GitHub or GitLab.
-                Both web URLs and git URLs are accepted.
-
-                In the absence of this option, citop will work with the
-                git repository located in the current directory. If
-                there is no such repository, citop will fail.
+                Specify the git repository to monitor. If REPOSITORY is
+                the path of a local repository, citop will monitor all
+                the associated remotes. If REPOSITORY is a URL, citop
+                will monitor the corresponding online repository.
+                If this option is not set, citop will behave as if it
+                had been set to the path of the current directory.
+                Note that citop will only monitor repositories hosted
+                on GitLab or GitHub.
 
   -h, --help    Show usage
 

cache/cache.go

@@ -215,7 +215,7 @@ func (c Commit) Strings() []text.StyledString {
 	return texts
 }
 
-func GitOriginURL(path string, ref string) ([]string, Commit, error) {
+func RemotesAndCommit(path string, ref string) ([]string, Commit, error) {
 	// If a path does not refer to an existing file or directory, go-git will continue
 	// running and will walk its way up the directory structure looking for a .git repository.
 	// This is not ideal for us since running 'citop -r github.com/owner/repo' from
@@ -637,7 +637,7 @@ func (c *Cache) broadcastMonitorPipeline(ctx context.Context, u string, ref stri
 // channel urlc once. If no provider is able to handle the specified URL, ErrUnknownRepositoryURL
 // is returned.
 func (c *Cache) broadcastMonitorRefStatus(ctx context.Context, repo string, ref string, commitc chan<- Commit, b backoff.ExponentialBackOff) error {
-	repositoryURLs, commit, err := GitOriginURL(repo, ref)
+	repositoryURLs, commit, err := RemotesAndCommit(repo, ref)
 	switch err {
 	case nil:
 		select {

cache/cache_test.go

@@ -534,7 +534,7 @@ func createRepository(t *testing.T, remotes []config.RemoteConfig) (string, stri
 
 func TestGitOriginURL(t *testing.T) {
 	t.Run("invalid path", func(t *testing.T) {
-		_, _, err := GitOriginURL("invalid path", "HEAD")
+		_, _, err := RemotesAndCommit("invalid path", "HEAD")
 		if err != ErrUnknownRepositoryURL {
 			t.Fatalf("expected %v but got %v", ErrUnknownRepositoryURL, err)
 		}
@@ -544,7 +544,7 @@ func TestGitOriginURL(t *testing.T) {
 		repositoryPath, _ := createRepository(t, nil)
 		defer os.RemoveAll(repositoryPath)
 
-		_, _, err := GitOriginURL(path.Join(repositoryPath, "invalidpath"), "HEAD")
+		_, _, err := RemotesAndCommit(path.Join(repositoryPath, "invalidpath"), "HEAD")
 		if err != ErrUnknownRepositoryURL {
 			t.Fatalf("expected %v but got %v", ErrUnknownRepositoryURL, err)
 		}
@@ -566,7 +566,7 @@ func TestGitOriginURL(t *testing.T) {
 		repositoryPath, _ := createRepository(t, remotes)
 		defer os.RemoveAll(repositoryPath)
 
-		urls, _, err := GitOriginURL(repositoryPath, "HEAD")
+		urls, _, err := RemotesAndCommit(repositoryPath, "HEAD")
 		if err != nil {
 			t.Fatal(err)
 		}
@@ -601,7 +601,7 @@ func TestGitOriginURL(t *testing.T) {
 
 		for _, ref := range references {
 			t.Run(fmt.Sprintf("reference %q", ref), func(t *testing.T) {
-				_, commit, err := GitOriginURL(repositoryPath, ref)
+				_, commit, err := RemotesAndCommit(repositoryPath, ref)
 				if err != nil {
 					t.Fatal(err)
 				}

docs/citop.man.html

@@ -101,8 +101,8 @@ <h2 id="commit"><code>COMMIT</code></h2>
 citop feature/doc</code></pre>
 <h1 id="options">OPTIONS</h1>
 <h2 id="rrepository---repositoryrepository"><code>-r=REPOSITORY, --repository=REPOSITORY</code></h2>
-<p>Specify the git repository to work with. REPOSITORY can be either a path to a local git repository, or the URL of an online repository hosted at GitHub or GitLab. Both web URLs and git URLs are accepted.</p>
-<p>In the absence of this option, citop will work with the git repository located in the current directory. If there is no such repository, citop will fail.</p>
+<p>Specify the git repository to monitor. REPOSITORY can be either a path to a local git repository, or the URL of an online repository hosted at GitHub or GitLab. Both web URLs and git URLs are accepted.</p>
+<p>In the absence of this option, citop will monitor the git repository located in the current directory. If there is no such repository, citop will fail.</p>
 <p>Examples:</p>
 <pre class="shell"><code># Work with the git repository in the current directory
 citop

main.go

@@ -235,14 +235,14 @@ Positional arguments:
 
 Options:
   -r REPOSITORY, --repository REPOSITORY
-                Specify the git repository to work with. REPOSITORY can
-                be either a path to a local git repository, or the URL
-                of an online repository hosted at GitHub or GitLab.
-                Both web URLs and git URLs are accepted.
-
-                In the absence of this option, citop will work with the
-                git repository located in the current directory. If
-                there is no such repository, citop will fail.
+                Specify the git repository to monitor. If REPOSITORY is
+                the path of a local repository, citop will monitor all
+                the associated remotes. If REPOSITORY is a URL, citop
+                will monitor the corresponding online repository.
+                If this option is not set, citop will behave as if it
+                had been set to the path of the current directory.
+                Note that citop will only monitor repositories hosted
+                on GitLab or GitHub.
 
   -h, --help    Show usage
 

man.go

@@ -124,27 +124,30 @@ citop feature/doc
 .SH OPTIONS
 .SS \f[C]-r=REPOSITORY, --repository=REPOSITORY\f[R]
 .PP
-Specify the git repository to work with.
-REPOSITORY can be either a path to a local git repository, or the URL of
-an online repository hosted at GitHub or GitLab.
-Both web URLs and git URLs are accepted.
+Specify the git repository to monitor.
+If REPOSITORY is the path of a local repository, citop will monitor all
+the associated remotes.
+If REPOSITORY is a URL, citop will monitor the corresponding online
+repository.
+.PP
+If this option is not set, citop will behave as if it had been set to
+the path of the current directory.
 .PP
-In the absence of this option, citop will work with the git repository
-located in the current directory.
-If there is no such repository, citop will fail.
+Note that citop will only monitor repositories hosted on GitLab or
+GitHub.
 .PP
 Examples:
 .IP
 .nf
 \f[C]
-# Work with the git repository in the current directory
+# Monitor pipelines of the git repository in the current directory
 citop
-# Work with the repository specified by a web URL
+# Monitor pipelines of the repository specified by a web URL
 citop -r https://gitlab.com/nbedos/citop
 citop -r github.com/nbedos/citop
 # Git URLs are accepted
 citop -r git\[at]github.com:nbedos/citop.git
-# Paths to a local repository are accepted too
+# A path referring to a local repository is valid too
 citop -r /home/user/repos/myrepo
 \f[R]
 .fi

man.md

@@ -56,23 +56,25 @@ citop feature/doc
 
 # OPTIONS
 ## `-r=REPOSITORY, --repository=REPOSITORY`
-Specify the git repository to work with. REPOSITORY can be either a path to a local git repository,
-or the URL of an online repository hosted at GitHub or GitLab. Both web URLs and git URLs are
-accepted.
+Specify the git repository to monitor. If REPOSITORY is the path of a local repository, citop
+will monitor all the associated remotes. If REPOSITORY is a URL, citop will monitor the
+corresponding online repository. 
 
-In the absence of this option, citop will work with the git repository located in the current 
-directory. If there is no such repository, citop will fail.
+If this option is not set, citop will behave as if it had been set to the path of the current
+directory.
+
+Note that citop will only monitor repositories hosted on GitLab or GitHub.
 
 Examples:
 ```shell
-# Work with the git repository in the current directory
+# Monitor pipelines of the git repository in the current directory
 citop
-# Work with the repository specified by a web URL
+# Monitor pipelines of the repository specified by a web URL
 citop -r https://gitlab.com/nbedos/citop
 citop -r github.com/nbedos/citop
 # Git URLs are accepted
 citop -r [email protected]:nbedos/citop.git
-# Paths to a local repository are accepted too
+# A path referring to a local repository is valid too
 citop -r /home/user/repos/myrepo
 ```