-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
9 changed files
with
142 additions
and
142 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,2 @@ | ||
| .vscode | ||
| .idea | ||
| .mage/tools |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| tools/ | ||
| bin/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| module sage | ||
|
|
||
| go 1.17 | ||
|
|
||
| require ( | ||
| github.com/go-logr/logr v1.2.2 | ||
| go.einride.tech/sage v0.53.0 | ||
| ) | ||
|
|
||
| require ( | ||
| github.com/iancoleman/strcase v0.2.0 // indirect | ||
| gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "os" | ||
| "regexp" | ||
| "strings" | ||
|
|
||
| "github.com/go-logr/logr" | ||
| "go.einride.tech/sage/sg" | ||
| "go.einride.tech/sage/tools/sgconvco" | ||
| "go.einride.tech/sage/tools/sggit" | ||
| "go.einride.tech/sage/tools/sggo" | ||
| "go.einride.tech/sage/tools/sggolangcilint" | ||
| "go.einride.tech/sage/tools/sggoreview" | ||
| "go.einride.tech/sage/tools/sgmarkdownfmt" | ||
| "go.einride.tech/sage/tools/sgyamlfmt" | ||
| ) | ||
|
|
||
| func main() { | ||
| sg.GenerateMakefiles( | ||
| sg.Makefile{ | ||
| Path: sg.FromGitRoot("Makefile"), | ||
| DefaultTarget: All, | ||
| }, | ||
| ) | ||
| } | ||
|
|
||
| func All(ctx context.Context) error { | ||
| sg.Deps(ctx, ConvcoCheck, GolangciLint, GoReview, GoTest, FormatMarkdown, FormatYAML, ReadmeSnippet) | ||
| sg.SerialDeps(ctx, GoModTidy, GitVerifyNoDiff) | ||
| return nil | ||
| } | ||
|
|
||
| func FormatYAML(ctx context.Context) error { | ||
| logr.FromContextOrDiscard(ctx).Info("formatting YAML files...") | ||
| return sgyamlfmt.FormatYAML(ctx) | ||
| } | ||
|
|
||
| func GoModTidy(ctx context.Context) error { | ||
| logr.FromContextOrDiscard(ctx).Info("tidying Go module files...") | ||
| return sg.Command(ctx, "go", "mod", "tidy", "-v").Run() | ||
| } | ||
|
|
||
| func GoTest(ctx context.Context) error { | ||
| logr.FromContextOrDiscard(ctx).Info("running Go tests...") | ||
| return sggo.TestCommand(ctx).Run() | ||
| } | ||
|
|
||
| func GoReview(ctx context.Context) error { | ||
| logr.FromContextOrDiscard(ctx).Info("reviewing Go files...") | ||
| return sggoreview.Command(ctx, "-c", "1", "./...").Run() | ||
| } | ||
|
|
||
| func GolangciLint(ctx context.Context) error { | ||
| logr.FromContextOrDiscard(ctx).Info("linting Go files...") | ||
| return sggolangcilint.RunCommand(ctx).Run() | ||
| } | ||
|
|
||
| func FormatMarkdown(ctx context.Context) error { | ||
| logr.FromContextOrDiscard(ctx).Info("formatting Markdown files...") | ||
| return sgmarkdownfmt.Command(ctx, "-w", ".").Run() | ||
| } | ||
|
|
||
| func ConvcoCheck(ctx context.Context) error { | ||
| logr.FromContextOrDiscard(ctx).Info("checking git commits...") | ||
| return sgconvco.Command(ctx, "check", "origin/master..HEAD").Run() | ||
| } | ||
|
|
||
| func GitVerifyNoDiff(ctx context.Context) error { | ||
| logr.FromContextOrDiscard(ctx).Info("verifying that git has no diff...") | ||
| return sggit.VerifyNoDiff(ctx) | ||
| } | ||
|
|
||
| func ReadmeSnippet(ctx context.Context) error { | ||
| usage := sg.Output(sg.Command(ctx, "go", "run", "./examples/cmd/grpc-server", "-help")) | ||
| usage = strings.TrimSpace(usage) | ||
| usage = "<!-- BEGIN usage -->\n\n```\n" + usage | ||
| usage = usage + "\n```\n\n<!-- END usage -->" | ||
| readme, err := os.ReadFile("README.md") | ||
| if err != nil { | ||
| return err | ||
| } | ||
| usageRegexp, err := regexp.Compile(`(?ms)<!-- BEGIN usage -->.*<!-- END usage -->`) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if !usageRegexp.Match(readme) { | ||
| return fmt.Errorf("found no match for 'usage' snippet in README.md") | ||
| } | ||
| return os.WriteFile("README.md", usageRegexp.ReplaceAll(readme, []byte(usage)), 0o600) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,56 +1,53 @@ | ||
| # Code generated by go.einride.tech/mage-tools. DO NOT EDIT. | ||
| # To learn more, see .mage/magefile.go and https://github.com/einride/mage-tools. | ||
| # Code generated by go.einride.tech/sage. DO NOT EDIT. | ||
| # To learn more, see .sage/sagefile.go and https://github.com/einride/sage. | ||
|
|
||
| .DEFAULT_GOAL := all | ||
|
|
||
| magefile := .mage/tools/bin/magefile | ||
| sagefile := .sage/bin/sagefile | ||
|
|
||
| $(magefile): .mage/go.mod .mage/*.go | ||
| @cd .mage && go run go.einride.tech/mage-tools/cmd/build | ||
| $(sagefile): .sage/go.mod .sage/*.go | ||
| @cd .sage && go mod tidy && go run . | ||
|
|
||
| .PHONY: clean-mage-tools | ||
| clean-mage-tools: | ||
| @git clean -fdx .mage/tools | ||
| .PHONY: clean-sage | ||
| clean-sage: | ||
| @git clean -fdx .sage/tools | ||
|
|
||
| .PHONY: all | ||
| all: $(magefile) | ||
| @$(magefile) all | ||
| all: $(sagefile) | ||
| @$(sagefile) All | ||
|
|
||
| .PHONY: convco-check | ||
| convco-check: $(magefile) | ||
| ifndef rev | ||
| $(error missing argument rev="...") | ||
| endif | ||
| @$(magefile) convcoCheck $(rev) | ||
| convco-check: $(sagefile) | ||
| @$(sagefile) ConvcoCheck | ||
|
|
||
| .PHONY: format-markdown | ||
| format-markdown: $(magefile) | ||
| @$(magefile) formatMarkdown | ||
| format-markdown: $(sagefile) | ||
| @$(sagefile) FormatMarkdown | ||
|
|
||
| .PHONY: format-yaml | ||
| format-yaml: $(magefile) | ||
| @$(magefile) formatYaml | ||
| format-yaml: $(sagefile) | ||
| @$(sagefile) FormatYAML | ||
|
|
||
| .PHONY: git-verify-no-diff | ||
| git-verify-no-diff: $(magefile) | ||
| @$(magefile) gitVerifyNoDiff | ||
| git-verify-no-diff: $(sagefile) | ||
| @$(sagefile) GitVerifyNoDiff | ||
|
|
||
| .PHONY: go-mod-tidy | ||
| go-mod-tidy: $(magefile) | ||
| @$(magefile) goModTidy | ||
| go-mod-tidy: $(sagefile) | ||
| @$(sagefile) GoModTidy | ||
|
|
||
| .PHONY: go-review | ||
| go-review: $(sagefile) | ||
| @$(sagefile) GoReview | ||
|
|
||
| .PHONY: go-test | ||
| go-test: $(magefile) | ||
| @$(magefile) goTest | ||
| go-test: $(sagefile) | ||
| @$(sagefile) GoTest | ||
|
|
||
| .PHONY: golangci-lint | ||
| golangci-lint: $(magefile) | ||
| @$(magefile) golangciLint | ||
|
|
||
| .PHONY: goreview | ||
| goreview: $(magefile) | ||
| @$(magefile) goreview | ||
| golangci-lint: $(sagefile) | ||
| @$(sagefile) GolangciLint | ||
|
|
||
| .PHONY: readme-snippet | ||
| readme-snippet: $(magefile) | ||
| @$(magefile) readmeSnippet | ||
| readme-snippet: $(sagefile) | ||
| @$(sagefile) ReadmeSnippet |