rename checks to exec

Author: mumoshu

.github/workflows/dev.yml

@@ -48,7 +48,7 @@ jobs:
         make build
     - name: dev1
       run: |
-        bin/actions checks -run dev1 -- bin/actions pullvet -require-any -label dev1
+        bin/actions exec -check-run-name dev1 -- bin/actions pullvet -require-any -label dev1
       env:
         GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
   ensure-dev2:
@@ -63,7 +63,7 @@ jobs:
         make build
     - name: dev2
       run: |
-        bin/actions checks -run dev2 -- bin/actions pullvet -require-any -label dev2 -label dev3
+        bin/actions exec -check-run-name dev2 -- bin/actions pullvet -require-any -label dev2 -label dev3
       env:
         GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
   ensure-dev3:
@@ -78,7 +78,7 @@ jobs:
         make build
     - name: dev3
       run: |
-        bin/actions checks -status-context checks/dev3 -- bin/actions pullvet -require-any -label dev3
+        bin/actions exec -status-context checks/dev3 -- bin/actions pullvet -require-any -label dev3
       env:
         GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
   ensure-changelog:
@@ -93,7 +93,7 @@ jobs:
         make build
     - name: changelog
       run: |
-        bin/actions checks -status-context checks/changelog -- bin/actions pullvet -require-any -note changelog1 -note changelog2
+        bin/actions exec -status-context checks/changelog -- bin/actions pullvet -require-any -note changelog1 -note changelog2
       env:
         GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
   ensure-releasenote:
@@ -104,6 +104,6 @@ jobs:
       with:
         entrypoint: sh
         args: |
-          -c "actions checks -status-context checks/releasenote -- actions pullvet -require-any -label releasenote/none -note releasenote"
+          -c "actions exec -status-context checks/releasenote -- actions pullvet -require-any -label releasenote/none -note releasenote"
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Makefile

@@ -1,8 +1,8 @@
 build/pullvet:
 	go build -o bin/pullvet ./cmd/pullvet
 
-build/checks:
-	go build -o bin/checks ./cmd/checks
+build/exec:
+	go build -o bin/exec ./cmd/exec
 
 build:
 	go build -o bin/actions ./cmd

README.md

@@ -10,7 +10,7 @@ Use for as-is, or reference and inspiration of your own command.
 
 - [pullvet](https://github.com/variantdev/go-actions/tree/master/cmd/pullvet) checks labels and milestones associated to each pull request for project management and compliance.
    A pullvet rule looks like `accept only PR that does have at least one of these labels and one or more release notes in the description`.
-- [checks](https://github.com/variantdev/go-actions/tree/master/cmd/checks) checks	drives GitHub Checks by creating CheckSuite and CheckRun, running and updating CheckRun
+- [exec](https://github.com/variantdev/go-actions/tree/master/cmd/xec) checks	drives GitHub Checks by creating CheckSuite and CheckRun, running and updating CheckRun
 
 ## Usage
 
@@ -27,7 +27,7 @@ Usage:
   actions [command]
 Available Commands:
   pullvet	checks labels and milestones associated to each pull request for project management and compliance
-  checks    checks	drives GitHub Checks by creating CheckSuite and CheckRun, running and updating CheckRun
+  exec      runs an arbitrary command and updates GitHub "Check Run" and/or "Status" accordingly
 
 Use "actions [command] --help" for more information about a command
 ```

cmd/checks/README.md

@@ -32,7 +32,7 @@ Usage of bin/checks:
 > and there's currently no way to obtain an installation token locally,
 > you can't test this locally.
 
-Capture actual webhook payloads for `pull_request`, `check_suite`, `check_run` events by running `cat /github/workflow/event.json` on GitHub Actions.
+Capture actual webhook payloads for `pull_request`, `check_suite`, `check_run` events by running `cat $GITHUB_EVENT_PATH` on GitHub Actions.
 
 Install this workflow onto your test repository:
 

cmd/checks/checks.go

@@ -8,13 +8,8 @@ import (
 	"github.com/variantdev/go-actions/pkg/checks"
 )
 
-// pullvet checks for the existence of the specified pull request label(s)  exists with a non-zero status
-// whenever one ore more required labels are missing in the pull request
-//
-// This should be useful for compliance purpose. that is, it will help preventing any  pr from being merged when it misses required labels.
-// when run on GitHub Actions v2
 func main() {
-	cmd := checks.New()
+	cmd := exec.New()
 
 	fs := flag.CommandLine
 	fs.Init("checks", flag.ExitOnError)

cmd/exec/README.md

@@ -0,0 +1,67 @@
+# checks
+
+`exec` runs an arbitrary command and updates GitHub "Check Run" and/or "Status" accordingly. 
+
+## Rationale
+
+GitHub Actions v2 has a known issue that prevents the "Required Status Checks" branch protection from working due to
+duplicate pull request statuses created by multiple workflow runs against a specific Git commit.
+
+Give me a simple CLI program that updates Check Run and/or pull request Status without duplication so that the branch protection works.
+
+## Usage
+
+```
+$ bin/actions exec -help
+Usage of exec:
+  -check-run-name string
+    	CheckRun's name to be updated after the command in run
+  -github-base-url string
+
+  -github-upload-url string
+
+  -status-context exec
+    	Commit status' context. If not empty, exec creates a status with this context
+  -status-description exec
+    	Commit status' description. exec creates a status with this description
+```
+
+## Running locally
+
+Capture actual webhook payloads for `pull_request`by running `cat $GITHUB_EVENT_PATH` on GitHub Actions.
+
+Install this workflow onto your test repository:
+
+https://github.com/variantdev/variant-github-actions-demo/blob/master/.github/workflows/dump-event.yml
+
+Open a PR against the repo:
+
+```
+git checkout -b test
+git commit --allow-empty
+git push
+hub pull-request
+```
+
+Browse to the Actions tab in your repo:
+
+```
+open https://github.com/USER/REPO/actions
+```
+
+Nagivate to the workflow run that corresponds to the pull request and browse `View raw logs` in the popup menu.
+
+Copy the dump of the event.json and save it as a json file:
+
+```
+$ pbpaste | awk '{$1=""; print $0;}' > pull_request_event.json
+```
+
+Then build and run `exec` against json files containing captured events:
+
+```
+$ make build/exec
+
+# Typically this is run on Actions with `on: pull_requqest`
+$ GITHUB_TOKEN_TYPE=bearer GITHUB_EVENT_PATH=$(pwd)/pull_request_event.json GITHUB_EVENT_NAME=pull_request bin/exec -status-context ci/test
+```

cmd/exec/exec.go

@@ -0,0 +1,24 @@
+package main
+
+import (
+	"flag"
+	"fmt"
+	"os"
+
+	"github.com/variantdev/go-actions/pkg/exec"
+)
+
+func main() {
+	cmd := exec.New()
+
+	fs := flag.CommandLine
+	fs.Init("exec", flag.ExitOnError)
+	cmd.AddFlags(fs)
+
+	flag.Parse()
+
+	if err := cmd.Run(fs.Args()); err != nil {
+		fmt.Fprintf(os.Stderr, "%v\n", err)
+		os.Exit(1)
+	}
+}

cmd/main.go

@@ -5,7 +5,7 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/variantdev/go-actions/pkg/checks"
+	"github.com/variantdev/go-actions/pkg/exec"
 	"github.com/variantdev/go-actions/pkg/pullvet"
 )
 
@@ -16,7 +16,7 @@ Usage:
   actions [command]
 Available Commands:
   pullvet	checks labels and milestones associated to each pull request for project management and compliance
-  checks	drives GitHub Checks by creating CheckSuite and CheckRun, running and updating CheckRun
+  exec		runs an arbitrary command and updates GitHub "Check Run" and/or "Status" accordingly.
 
 Use "actions [command] --help" for more information about a command
 `
@@ -31,7 +31,7 @@ func fatal(format string, args ...interface{}) {
 
 const (
 	CmdPullvet = "pullvet"
-	CmdChecks  = "checks"
+	CmdExec    = "exec"
 )
 
 func main() {
@@ -53,9 +53,9 @@ func main() {
 		if err := cmd.Run(); err != nil {
 			fatal("%v\n", err)
 		}
-	case CmdChecks:
-		fs := flag.NewFlagSet(CmdChecks, flag.ExitOnError)
-		cmd := checks.New()
+	case CmdExec:
+		fs := flag.NewFlagSet(CmdExec, flag.ExitOnError)
+		cmd := exec.New()
 		cmd.AddFlags(fs)
 
 		fs.Parse(os.Args[2:])

pkg/checks/checks.go

@@ -22,9 +22,10 @@ type Command struct {
 	BaseURL, UploadURL string
 	createRuns         cmd.StringSlice
 
-	checkName string
+	checkRunName string
 
-	statusContext string
+	statusContext     string
+	statusDescription string
 
 	cmd  string
 	args []string
@@ -41,8 +42,9 @@ func (c *Command) AddFlags(fs *flag.FlagSet) {
 	fs.StringVar(&c.BaseURL, "github-base-url", "", "")
 	fs.StringVar(&c.UploadURL, "github-upload-url", "", "")
 	fs.Var(&c.createRuns, "create-run", "Name of CheckRun to be created on CheckSuite `(re)requested` event. Specify multiple times to create two or more runs")
-	fs.StringVar(&c.checkName, "run", "", "CheckRun's name to be updated after the command in run")
-	fs.StringVar(&c.statusContext, "status-context", "", "Commit status' context. If not empty, `checks` creates a status with this contecxt")
+	fs.StringVar(&c.checkRunName, "check-run-name", "", "CheckRun's name to be updated after the command in run")
+	fs.StringVar(&c.statusContext, "status-context", "", "Commit status' context. If not empty, `exec` creates a status with this context")
+	fs.StringVar(&c.statusDescription, "status-description", "", "Commit status' description. `exec` creates a status with this description")
 }
 
 func (c *Command) Run(args []string) error {
@@ -178,21 +180,21 @@ func (c *Command) EnsureCheckRun(pre *github.PullRequestEvent) error {
 	owner := pre.Repo.Owner.GetLogin()
 	repo := pre.Repo.GetName()
 
-	if c.checkName != "" {
+	if c.checkRunName != "" {
 		suite, err := c.EnsureCheckSuite(pre)
 		if err != nil {
 			return err
 		}
 
 		cr := Run{
-			name:    c.checkName,
+			name:    c.checkRunName,
 			owner:   owner,
 			repo:    repo,
 			suiteId: suite.GetID(),
 		}
 
 		checkRunsList, _, err := client.Checks.ListCheckRunsCheckSuite(context.Background(), cr.owner, cr.repo, cr.suiteId, &github.ListCheckRunsOptions{
-			CheckName: github.String(c.checkName),
+			CheckName: github.String(c.checkRunName),
 			// TODO
 			//ListOptions: github.ListOptions{},
 		})
@@ -286,8 +288,8 @@ func (c *Command) ExecCheckRun(e *github.CheckRunEvent) error {
 }
 
 func (c *Command) UpdateCheckRun(owner, repo string, checkRun *github.CheckRun, summary, text string, runErr error) error {
-	if checkRun.GetName() != c.checkName {
-		return fmt.Errorf("unexpected run name: expected %q, got %q", c.checkName, checkRun.GetName())
+	if checkRun.GetName() != c.checkRunName {
+		return fmt.Errorf("unexpected run name: expected %q, got %q", c.checkRunName, checkRun.GetName())
 	}
 
 	client, err := c.instTokenClient()
@@ -327,7 +329,7 @@ func (c *Command) UpdateCheckRun(owner, repo string, checkRun *github.CheckRun,
 }
 
 func (c *Command) runIt() (string, string, error) {
-	return runCmd(c.cmd, c.args)
+	return actions.RunCmd(c.cmd, c.args)
 }
 
 func (c *Command) logResponseAndError(suites *github.ListCheckSuiteResults, res *github.Response, err error) error {
@@ -374,10 +376,10 @@ func (c *Command) getSuite(pre *github.PullRequestEvent) (*github.CheckSuite, er
 
 	c.logResponseAndError(suites, res, err)
 
-	log.Printf("Listing relevant suites for check name %q...", c.checkName)
+	log.Printf("Listing relevant suites for check name %q...", c.checkRunName)
 
 	suites, res, err = client.Checks.ListCheckSuitesForRef(context.Background(), owner, repo, sha, &github.ListCheckSuiteOptions{
-		CheckName: github.String(c.checkName),
+		CheckName: github.String(c.checkRunName),
 	})
 
 	if err := c.logResponseAndError(suites, res, err); err != nil {
@@ -468,4 +470,3 @@ func (c *Command) CreateCheckSuite(pre *github.PullRequestEvent) (*github.CheckS
 func (c *Command) instTokenClient() (*github.Client, error) {
 	return actions.CreateInstallationTokenClient(os.Getenv("GITHUB_TOKEN"), c.BaseURL, c.UploadURL)
 }
-