GitHub Actions: Fix Update Version Data workflow; Make txtar stable (#54)

Author: tangrufus

.gitattributes

@@ -5,7 +5,7 @@
 
 # Export white-listed production code only.
 /bin            -export-ignore
-/resources      -export-ignore
+/data           -export-ignore
 /src            -export-ignore
 /composer.json  -export-ignore
 /composer.lock  -export-ignore

.github/workflows/update-data.yml

@@ -0,0 +1,42 @@
+name: Update Version Data
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: 13 3 * * 1 # Weekly on Monday
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref_name }}
+  cancel-in-progress: true
+
+permissions: {}
+
+jobs:
+  update-data:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.4'
+          coverage: none
+
+      - uses: actions/setup-go@v6
+        with:
+          go-version-file: 'go.mod'
+
+      - run: make version-data
+        env:
+          MAKEFLAGS: "--jobs=4 --output-sync=target"
+
+      - uses: typisttech/.github/.github/actions/create-auto-merged-pull-request@v2
+        with:
+          app-id: ${{ vars.TASTENDRUCK_APP_ID }}
+          private-key: ${{ secrets.TASTENDRUCK_PRIVATE_KEY }}
+          branch: "tastendruck/github_actions/update-data/${{ github.ref_name }}"
+          title: ":robot: `make version-data`"
+          labels: update_data

.github/workflows/update-version-data.yml

@@ -12,16 +12,27 @@ bin: vendor
 
 test-%: %
 	PATH="$(shell pwd)/$*:$(shell echo $$PATH)" \
-	go test -count=1 ./...
+		go test -count=1 ./...
 
-tests/data/releases-%.json: FORCE
-	curl 'https://www.php.net/releases/index.php?json&max=1000&version=$*' | jq . > ./tests/data/releases-$*.json
+.PHONY: tests/data/versions
+tests/data/versions: MAJORS := 5 7 8
+tests/data/versions:
+	rm -rf tests/data/versions
+	mkdir -p tests/data/versions
+	$(MAKE) $(foreach MAJOR,$(MAJORS),tests/data/versions/v$(MAJOR).json)
 
-resources/all-versions.json: bin tests/data/releases-5.json tests/data/releases-7.json tests/data/releases-8.json
+tests/data/versions/v%.json: FORCE
+	curl 'https://www.php.net/releases/index.php?json&max=1000&version=$*' | \
+		jq . > tests/data/versions/v$*.json
+
+.PHONY: data/all-versions.json
+data/all-versions.json: bin
 	./bin/update-all-versions
 
---go-generate:
-	go generate ./...
+.PHONY: version-data
+version-data: data/all-versions.json tests/data/versions
 
-txtar: resources/all-versions.json --go-generate
-	$(MAKE) UPDATE_SCRIPTS=1 test-bin
+.PHONY: txtar
+txtar: data/all-versions.json
+	go generate ./...
+	UPDATE_SCRIPTS=1 $(MAKE) test-bin

Makefile

@@ -91,7 +91,7 @@ Available modes:
 Available sources:
 - `auto` *(default)*: Use `offline` in `minor-only` mode. Otherwise, fetch from [php.net](https://www.php.net/releases/index.php)
 - `php.net`: Fetch releases information from [php.net](https://www.php.net/releases/index.php)
-- `offline`: Use [hardcoded releases](resources/all-versions.json) information
+- `offline`: Use [hardcoded releases](data/all-versions.json) information
 
 ## Installation
 

README.md

@@ -12,5 +12,10 @@ $releases = new PhpNetReleases;
 $data = $releases->all();
 $data = Semver::rsort($data);
 
+$dir = __DIR__.'/../data';
+@mkdir($dir, 0755);
+
 $content = json_encode($data, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
-file_put_contents(__DIR__.'/../resources/all-versions.json', $content);
+file_put_contents($dir .'/all-versions.json', $content);
+
+echo "Done: '{$dir}/all-versions.json' updated".PHP_EOL;

bin/update-all-versions

@@ -1,14 +1,25 @@
 package internal
 
-var Constraints = []string{
+var EOLConstraints = []string{
 	"^7",
 	"^7.1",
 	"^7.1.2",
-	"^7.1.2 || ~8.1.2",
-	"^7 ^7.2",
+	"^7.1.2 || ~8.0.3",
+	"^7 <7.2.3",
+	"7@stable",
+}
+
+var SupportedConstraints = []string{
+	"^8",
+	"^8.2",
+	"^8.3.4",
+	"^8.2 || ~8.4.0",
+	"^8.2 <= 8.4.1",
+	"^7.4 || ^8.4",
+	">=7.4",
 	"*",
 	"@stable",
-	"^7@stable",
+	"^8@rc",
 }
 
 var Modes = []string{

resources/all-versions.json data/all-versions.jsonresources/all-versions.json renamed to data/all-versions.json

@@ -81,7 +81,9 @@ func (d data) Write(f *os.File) error {
 }
 
 func main() {
-	var cases []data
+	num := len(internal.Modes) * len(rawCases)
+	cases := make([]data, 0, num)
+
 	for _, mode := range internal.Modes {
 		for _, r := range rawCases {
 			cases = append(cases, data{

internal/common.go

@@ -8,7 +8,7 @@ import (
 	"github.com/typisttech/php-matrix/internal"
 )
 
-const fileTemplateRaw = `# DO NOT EDIT THIS FILE
+const eolTemplateRaw = `# DO NOT EDIT THIS FILE
 # This file is generated by "internal/composer/success/main.go"
 # Test the '{{ .Name }}' case
 
@@ -34,28 +34,65 @@ cmp stdout stdout.golden
 -- stdout.golden --
 `
 
-var fileTemplate = template.Must(template.New("").Parse(fileTemplateRaw))
+const supportedTemplateRaw = `# DO NOT EDIT THIS FILE
+# This file is generated by "internal/composer/success/main.go"
+# Test the '{{ .Name }}' case
+
+exec php-matrix composer {{ .Mode }}
+stdout .
+! stderr .
+
+exec php-matrix composer {{ .Mode }} --source=auto
+stdout .
+! stderr .
+
+exec php-matrix composer {{ .Mode }} --source=php.net
+stdout .
+! stderr .
+
+exec php-matrix composer {{ .Mode }} --source=offline
+stdout .
+! stderr .
+
+-- composer.json --
+{"require":{"php":"{{ .Constraint }}"}}
+`
+
+var eolFileTemplate = template.Must(template.New("").Parse(eolTemplateRaw))
+var supportedFileTemplate = template.Must(template.New("").Parse(supportedTemplateRaw))
 
 type data struct {
-	Mode       string
-	Constraint string
+	Mode         string
+	Constraint   string
+	fileTemplate *template.Template
 }
 
 func (d data) Name() string {
 	return fmt.Sprintf("%q__%q", d.Mode, d.Constraint)
 }
 
 func (d data) Write(f *os.File) error {
-	return fileTemplate.Execute(f, d)
+	return d.fileTemplate.Execute(f, d)
 }
 
 func main() {
-	var cases []data
+	num := len(internal.Modes) * (len(internal.EOLConstraints) + len(internal.SupportedConstraints))
+	cases := make([]data, 0, num)
+
 	for _, mode := range internal.Modes {
-		for _, constraint := range internal.Constraints {
+		for _, constraint := range internal.EOLConstraints {
+			cases = append(cases, data{
+				Mode:         mode,
+				Constraint:   constraint,
+				fileTemplate: eolFileTemplate,
+			})
+		}
+
+		for _, constraint := range internal.SupportedConstraints {
 			cases = append(cases, data{
-				Mode:       mode,
-				Constraint: constraint,
+				Mode:         mode,
+				Constraint:   constraint,
+				fileTemplate: supportedFileTemplate,
 			})
 		}
 	}