do not include metadata for actions which are known to be outdated

Author: rhysd

popular_actions.go

@@ -20,6 +20,14 @@ import (
 	"gopkg.in/yaml.v3"
 )
 
+// List of known outdated actions which cannot be detected from 'runs' in action.yml
+var outdatedActions = []string{
+	"actions/labeler@v1",
+	"actions/checkout@v1",
+	"actions/upload-artifact@v1",
+	"actions/download-artifact@v1",
+}
+
 type actionOutput struct {
 	Spec     string                     `json:"spec"`
 	Meta     *actionlint.ActionMetadata `json:"metadata"`
@@ -65,11 +73,16 @@ var defaultPopularActionsJSON []byte
 
 const minNodeRunnerVersion = 20
 
-func isOutdatedRunner(r string) bool {
-	if !strings.HasPrefix(r, "node") {
+func isOutdated(spec, runs string) bool {
+	for _, s := range outdatedActions {
+		if s == spec {
+			return true
+		}
+	}
+	if !strings.HasPrefix(runs, "node") {
 		return false
 	}
-	v, err := strconv.ParseUint(r[len("node"):], 10, 8)
+	v, err := strconv.ParseUint(runs[len("node"):], 10, 8)
 	return err == nil && v < minNodeRunnerVersion
 }
 
@@ -213,7 +226,7 @@ func (g *gen) fetchRemote() (map[string]*actionlint.ActionMetadata, error) {
 func (g *gen) writeJSONL(out io.Writer, actions map[string]*actionlint.ActionMetadata) error {
 	enc := json.NewEncoder(out)
 	for spec, meta := range actions {
-		j := actionOutput{spec, meta, isOutdatedRunner(meta.Runs.Using)}
+		j := actionOutput{spec, meta, isOutdated(spec, meta.Runs.Using)}
 		if err := enc.Encode(&j); err != nil {
 			return fmt.Errorf("could not encode action %q data into JSON: %w", spec, err)
 		}
@@ -242,7 +255,7 @@ var PopularActions = map[string]*ActionMetadata{
 	outdated := []string{}
 	for _, spec := range specs {
 		meta := actions[spec]
-		if isOutdatedRunner(meta.Runs.Using) {
+		if isOutdated(spec, meta.Runs.Using) {
 			outdated = append(outdated, spec)
 			continue
 		}

scripts/generate-popular-actions/main.go

@@ -68,11 +68,12 @@ func TestReadWriteJSONL(t *testing.T) {
 		"skip_both.jsonl",
 		"skip_both.jsonl",
 		"outdated.jsonl",
+		"known_outdated.jsonl",
 	}
 
 	for _, file := range files {
 		t.Run(file, func(t *testing.T) {
-			f := filepath.Join("testdata", "actions", file)
+			f := filepath.Join("testdata", "jsonl", file)
 			stdout := &bytes.Buffer{}
 			stderr := &bytes.Buffer{}
 
@@ -126,7 +127,7 @@ func TestWriteGoToStdout(t *testing.T) {
 		t.Run(tc.in, func(t *testing.T) {
 			stdout := &bytes.Buffer{}
 			stderr := &bytes.Buffer{}
-			status := newGen(stdout, stderr, io.Discard).run([]string{"test", "-s", filepath.Join("testdata", "actions", tc.in)})
+			status := newGen(stdout, stderr, io.Discard).run([]string{"test", "-s", filepath.Join("testdata", "jsonl", tc.in)})
 			if status != 0 {
 				t.Fatalf("exit status is non-zero: %d: %s", status, stderr.Bytes())
 			}
@@ -146,7 +147,7 @@ func TestWriteGoToStdout(t *testing.T) {
 }
 
 func TestWriteJSONLFile(t *testing.T) {
-	in := filepath.Join("testdata", "actions", "no_new_version.jsonl")
+	in := filepath.Join("testdata", "jsonl", "no_new_version.jsonl")
 	b, err := os.ReadFile(in)
 	if err != nil {
 		panic(err)
@@ -175,7 +176,7 @@ func TestWriteJSONLFile(t *testing.T) {
 }
 
 func TestWriteGoFile(t *testing.T) {
-	in := filepath.Join("testdata", "actions", "no_new_version.jsonl")
+	in := filepath.Join("testdata", "jsonl", "no_new_version.jsonl")
 	out := filepath.Join("testdata", "go", "out.go")
 	defer os.Remove(out)
 
@@ -246,7 +247,7 @@ func TestWriteOutdatedActionAsJSONL(t *testing.T) {
 		t.Fatal("exit status is non-zero:", status)
 	}
 
-	b, err := os.ReadFile(filepath.Join("testdata", "actions", "outdated.jsonl"))
+	b, err := os.ReadFile(filepath.Join("testdata", "jsonl", "outdated.jsonl"))
 	if err != nil {
 		panic(err)
 	}
@@ -257,7 +258,7 @@ func TestWriteOutdatedActionAsJSONL(t *testing.T) {
 }
 
 func TestLogOutput(t *testing.T) {
-	f := filepath.Join("testdata", "actions", "no_new_version.jsonl")
+	f := filepath.Join("testdata", "jsonl", "no_new_version.jsonl")
 	stdout := &bytes.Buffer{}
 	logged := &bytes.Buffer{}
 	status := newGen(stdout, io.Discard, logged).run([]string{"test", "-s", f, "-f", "jsonl"})
@@ -355,7 +356,7 @@ func TestCouldNotReadJSONLFile(t *testing.T) {
 	}
 	for _, tc := range testCases {
 		t.Run(tc.file, func(t *testing.T) {
-			f := filepath.Join("testdata", "actions", tc.file)
+			f := filepath.Join("testdata", "jsonl", tc.file)
 			stdout := io.Discard
 			stderr := &bytes.Buffer{}
 
@@ -373,7 +374,7 @@ func TestCouldNotReadJSONLFile(t *testing.T) {
 }
 
 func TestCouldNotCreateOutputFile(t *testing.T) {
-	f := filepath.Join("testdata", "actions", "no_new_version.jsonl")
+	f := filepath.Join("testdata", "jsonl", "no_new_version.jsonl")
 	out := filepath.Join("testdata", "this-dir-does-not-exit", "foo.jsonl")
 	stdout := io.Discard
 	stderr := &bytes.Buffer{}
@@ -398,7 +399,7 @@ func (w testErrorWriter) Write(b []byte) (int, error) {
 func TestWriteError(t *testing.T) {
 	for _, format := range []string{"go", "jsonl"} {
 		t.Run(format, func(t *testing.T) {
-			f := filepath.Join("testdata", "actions", "no_new_version.jsonl")
+			f := filepath.Join("testdata", "jsonl", "no_new_version.jsonl")
 			stdout := testErrorWriter{}
 			stderr := &bytes.Buffer{}
 

scripts/generate-popular-actions/main_test.go

@@ -0,0 +1 @@
+{"spec":"actions/checkout@v1","metadata":{"name":"Checkout","inputs":{"clean":{"name":"clean","required":false},"fetch-depth":{"name":"fetch-depth","required":false},"lfs":{"name":"lfs","required":false},"path":{"name":"path","required":false},"ref":{"name":"ref","required":false},"repository":{"name":"repository","required":false},"submodules":{"name":"submodules","required":false},"token":{"name":"token","required":false}},"outputs":null,"skip_inputs":false,"skip_outputs":false,"runs":{"using":"","main":"","pre":"","pre-if":"","post":"","post-if":"","steps":null,"image":"","pre-entrypoint":"","entrypoint":"","post-entrypoint":"","args":null,"env":null}},"outdated":true}

scripts/generate-popular-actions/testdata/actions/broken.jsonl renamed to scripts/generate-popular-actions/testdata/jsonl/broken.jsonl

@@ -0,0 +1,6 @@
+[
+    {
+      "slug": "actions/checkout",
+      "tags": ["v1"]
+    }
+]