gh-pr-revision: new name

This commit renames the tool from `gh-revision` to `gh-pr-revision`.
This is done because `pr` is a more natural namespace for the object
that this tool introduces. Ideally we would like to have a CLI command
`gh pr revision`. However, given that extensions cannot be put under a
builtin command, we rename the tool to have something closer to the
optimum.

The repository will be renamed accordingly as well.

Author: r-bk

.github/workflows/build.yaml

@@ -32,4 +32,4 @@ jobs:
       - name: Build
         run: make build
       - name: Show version
-        run: ./gh-revision --version
+        run: ./gh-pr-revision --version

.gitignore

@@ -24,6 +24,6 @@ go.work.sum
 # env file
 .env
 
-# gh-revision
-gh-revision
+# gh-pr-revision
+gh-pr-revision
 version.txt

Makefile

@@ -19,4 +19,4 @@ build: version
 
 .PHONY: clean
 clean:
-	@rm -f gh-revision version.txt
+	@rm -f gh-pr-revision version.txt

README.md

@@ -1,4 +1,4 @@
-# gh-revision
+# gh-pr-revision
 
 A GitHub CLI extension for managing pull request revisions.
 
@@ -14,26 +14,26 @@ changes harder.
 To make incremental changes more visible and easier to track we decided to add pull
 request comments which summarize what was changed since the last review.
 To automate this process and add diff links to the previous revision the
-idea of `gh-revision` CLI extension was born.
+idea of `gh-pr-revision` CLI extension was born.
 
 ## Installation
 
 To install the latest version of the extension use the following command:
 
 ```shell
-gh extension install hushsecurity/gh-revision
+gh extension install hushsecurity/gh-pr-revision
 ```
 
 ## Synopsis
 
 ```shell
-gh revision --help
+gh pr-revision --help
 ```
 
 ```text
 GitHub CLI extension for pull request revisions
 v0.0.1
-Usage: gh-revision <command> [<args>]
+Usage: gh-pr-revision <command> [<args>]
 
 Options:
   --help, -h             display this help and exit
@@ -50,21 +50,21 @@ Commands:
 To create a new revision make sure your pull request is `OPEN` and is not `Draft`.
 
 ```shell
-gh revision create
+gh pr-revision create
 ```
 
 This command assumes that the new revision is associated with the `HEAD` commit.
 If the pull request tip commit is not the local `HEAD` specify a commitish
 explicitly:
 
 ```shell
-gh revision create -c "<commitish>"
+gh pr-revision create -c "<commitish>"
 ```
 
 To attach a custom comment to the revision use `-e` to open your configured editor:
 
 ```shell
-gh revision create -e
+gh pr-revision create -e
 ```
 
 ## Aliases
@@ -73,19 +73,21 @@ The name of the extension is relatively long. Therefore, it may be helpful to cr
 aliases as follows:
 
 ```shell
-gh alias set rvc 'revision create'
-gh alias set rvl 'revision list'
-gh alias set rvs 'revision show'
+gh alias set rvc 'pr-revision create'
+gh alias set rvl 'pr-revision list'
+gh alias set rvs 'pr-revision show'
 ```
 
 Now a new revision can be created with a shorter command `gh rvc -e`.
 
 ## Limitations
 
-1. `gh-revision` stores some metadata in pull request comments. Subsequent revisions
-   build on the metadata included in previous revisions. Hence, deletion of a *revision
-   comment* may affect correctness of following revision comments.
+1. `gh-pr-revision` stores some metadata in pull request comments. Subsequent revisions
+   build on the metadata included in previous revisions. Therefore, deletion of a
+   revision comment may affect correctness of following revisions.
 
-1. The size of a *revision comment* is limited by the max size of a
+1. The size of a revision comment is limited by the max size of a
    pull request comment allowed by GitHub. Therefore, if a pull request has a very
-   long list of revisions creation of a new one may fail due to GitHub limitations.
+   long list of revisions, creation of a new one may fail due to GitHub limitations.
+   This is because every new revision contains 2 additional comparison urls that make
+   the metadata bigger.

common.go

@@ -87,7 +87,7 @@ func addPrComment(path string) error {
 }
 
 func editUserComment(ioStreams *iostreams.IOStreams) (string, error) {
-	tmpFile, err := os.CreateTemp("", "gh-revision-user-comment.*.md")
+	tmpFile, err := os.CreateTemp("", "gh-pr-revision-user-comment.*.md")
 	if err != nil {
 		return "", fmt.Errorf("failed to create temporary file: %v", err)
 	}

create.go

@@ -142,7 +142,7 @@ func newPrComment(pr PullRequest, newRevision Revision, revisions []Revision) (p
 	}
 	fmt.Fprintf(&buf, "%s", encoded)
 
-	tmpFile, err := os.CreateTemp("", "gh-revision.*.md")
+	tmpFile, err := os.CreateTemp("", "gh-pr-revision.*.md")
 	if err != nil {
 		return "", fmt.Errorf("failed to create temporary file: %v", err)
 	}

go.mod

@@ -1,4 +1,4 @@
-module github.com/hushsecurity/gh-revision
+module github.com/hushsecurity/gh-pr-revision
 
 go 1.23.2
 

revision.go

@@ -8,10 +8,10 @@ import (
 )
 
 const (
-	mdPrefix  = "[//]: # (gh-revision:"
+	mdPrefix  = "[//]: # (gh-pr-revision:"
 	mdSuffix  = ")"
-	bodyStart = "[//]: # (gh-revision-body-start)"
-	bodyEnd   = "[//]: # (gh-revision-body-end)"
+	bodyStart = "[//]: # (gh-pr-revision-body-start)"
+	bodyEnd   = "[//]: # (gh-pr-revision-body-end)"
 )
 
 type Revision struct {