Skip to content

Commit 67e7e75

Browse files
author
Doug Hatcher
committed
basic configuration
1 parent b9a4ab8 commit 67e7e75

File tree

9 files changed

+311
-1
lines changed

9 files changed

+311
-1
lines changed

‎.github/workflows/codecov.yml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Test and coverage
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
build:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/checkout@v2
10+
with:
11+
fetch-depth: 2
12+
- uses: actions/setup-go@v2
13+
with:
14+
go-version: '1.14'
15+
- name: Run coverage
16+
run: go test -race -coverprofile=coverage.txt -covermode=atomic ./...
17+
- name: Upload coverage to Codecov
18+
run: bash <(curl -s https://codecov.io/bash)

‎.github/workflows/go.yml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Go
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
11+
build:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v2
15+
16+
- name: Set up Go
17+
uses: actions/setup-go@v2
18+
with:
19+
go-version: 1.15
20+
21+
- name: Build
22+
run: go build -v ./...
23+
24+
- name: Test
25+
run: go test -v ./...

‎.github/workflows/goreleaser.yml

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: goreleaser
2+
3+
on:
4+
release:
5+
types: [created]
6+
7+
permissions:
8+
contents: write
9+
10+
jobs:
11+
goreleaser:
12+
runs-on: ubuntu-latest
13+
steps:
14+
-
15+
name: Checkout
16+
uses: actions/checkout@v2
17+
with:
18+
fetch-depth: 0
19+
-
20+
name: Set up Go
21+
uses: actions/setup-go@v2
22+
with:
23+
go-version: 1.16
24+
-
25+
name: Run GoReleaser
26+
uses: goreleaser/goreleaser-action@v2
27+
with:
28+
version: latest
29+
args: release --rm-dist
30+
env:
31+
GITHUB_TOKEN: ${{ secrets.GR_TOKEN }}
32+
33+

‎.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
composer.lock
2+
vendor
3+
var

‎.goreleaser.yml

+119
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
brews:
2+
-
3+
# Name template of the recipe
4+
# Default to project name
5+
name: magento-cli
6+
7+
# IDs of the archives to use.
8+
# Defaults to all.
9+
# ids:
10+
# - foo
11+
# - bar
12+
13+
# GOARM to specify which 32-bit arm version to use if there are multiple versions
14+
# from the build section. Brew formulas support atm only one 32-bit version.
15+
# Default is 6 for all artifacts or each id if there a multiple versions.
16+
goarm: 6
17+
18+
# NOTE: make sure the url_template, the token and given repo (github or gitlab) owner and name are from the
19+
# same kind. We will probably unify this in the next major version like it is done with scoop.
20+
21+
# GitHub/GitLab repository to push the formula to
22+
# Gitea is not supported yet, but the support coming
23+
tap:
24+
owner: superterran
25+
name: homebrew-magento-cli
26+
27+
# Template for the url which is determined by the given Token (github or gitlab)
28+
# Default for github is "https://github.com/<repo_owner>/<repo_name>/releases/download/{{ .Tag }}/{{ .ArtifactName }}"
29+
# Default for gitlab is "https://gitlab.com/<repo_owner>/<repo_name>/-/releases/{{ .Tag }}/downloads/{{ .ArtifactName }}"
30+
# Default for gitea is "https://gitea.com/<repo_owner>/<repo_name>/releases/download/{{ .Tag }}/{{ .ArtifactName }}"
31+
url_template: "https://github.com/superterran/magento-cli/releases/download/{{ .Tag }}/{{ .ArtifactName }}"
32+
33+
# Allows you to set a custom download strategy. Note that you'll need
34+
# to implement the strategy and add it to your tap repository.
35+
# Example: https://docs.brew.sh/Formula-Cookbook#specifying-the-download-strategy-explicitly
36+
# Default is empty.
37+
# download_strategy: CurlDownloadStrategy.
38+
39+
# Allows you to add a custom require_relative at the top of the formula template
40+
# Default is empty
41+
# custom_require: custom_download_strategy
42+
43+
# Git author used to commit to the repository.
44+
# Defaults are shown.
45+
commit_author:
46+
name: goreleaserbot
47+
email: [email protected]
48+
49+
# Folder inside the repository to put the formula.
50+
# Default is the root folder.
51+
folder: Formula
52+
53+
# Caveats for the user of your binary.
54+
# Default is empty.
55+
caveats: "How to use this binary"
56+
57+
# Your app's homepage.
58+
# Default is empty.
59+
homepage: "https://superterran.net/magento-cli/"
60+
61+
# Your app's description.
62+
# Default is empty.
63+
description: "tool for managing magento and serving local versions"
64+
65+
# SPDX identifier of your app's license.
66+
# Default is empty.
67+
license: "MIT"
68+
69+
# Setting this will prevent goreleaser to actually try to commit the updated
70+
# formula - instead, the formula file will be stored on the dist folder only,
71+
# leaving the responsibility of publishing it to the user.
72+
# If set to auto, the release will not be uploaded to the homebrew tap
73+
# in case there is an indicator for prerelease in the tag e.g. v1.0.0-rc1
74+
# Default is false.
75+
# skip_upload: true
76+
77+
# Custom block for brew.
78+
# Can be used to specify alternate downloads for devel or head releases.
79+
# Default is empty.
80+
# custom_block: |
81+
# head "https://github.com/some/package.git"
82+
# ...
83+
84+
# Packages your package depends on.
85+
dependencies:
86+
- name: docker
87+
type: optional
88+
- name: docker-compose
89+
type: optional
90+
- name: git
91+
type: optional
92+
93+
# Packages that conflict with your package.
94+
# conflicts:
95+
# - svn
96+
# - bash
97+
98+
# Specify for packages that run as a service.
99+
# Default is empty.
100+
# plist: |
101+
# <?xml version="1.0" encoding="UTF-8"?>
102+
# ...
103+
104+
# So you can `brew test` your formula.
105+
# Default is empty.
106+
test: |
107+
system "#{bin}/magento -h"
108+
109+
# Custom install script for brew.
110+
# Default is 'bin.install "program"'.
111+
install: |
112+
bin.install "magento"
113+
114+
# Custom post_install script for brew.
115+
# Could be used to do any additional work after the "install" script
116+
# Default is empty.
117+
# post_install: |
118+
# etc.install "app-config.conf"
119+
# ...

‎.vscode/launch.json

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
// Use IntelliSense to learn about possible attributes.
3+
// Hover to view descriptions of existing attributes.
4+
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
5+
"version": "0.2.0",
6+
"configurations": [
7+
{
8+
"name": "Launch Package",
9+
"type": "go",
10+
"request": "launch",
11+
"mode": "auto",
12+
"program": "${workspaceFolder}/main.go",
13+
"args": ["build", "example"]
14+
}
15+
]
16+
}

‎CONTRIBUTING.md

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Contributing
2+
3+
We love pull requests!
4+
5+
Fork, then clone the repo:
6+
7+
```bash
8+
git clone [email protected]:your-username/magento-cli.git
9+
```
10+
Set up your machine:
11+
12+
```bash
13+
cd magento-cli
14+
make build
15+
```
16+
17+
You can use cobra to create a new feature, but with unit testing it may be easier to dupliate the files already in use:
18+
19+
```bash
20+
cobra add <command>
21+
```
22+
23+
Make sure the existing tests pass:
24+
25+
```bash
26+
make test
27+
```
28+
29+
While creating new commands, don't forget to create a `_test.go` file.
30+
31+
Make your changes, Add tests for your change, Make the tests pass:
32+
33+
```bash
34+
make test
35+
```
36+
37+
Make your change. Add tests for your change. Make the tests pass:
38+
39+
```bash
40+
make test
41+
```
42+
43+
Push to your fork and [submit a pull request][pr].
44+
45+
[pr]: https://github.com/superterran/magento-cli/compare/
46+
47+
At this point you're waiting on us. We like to at least comment on pull requests
48+
within three business days (and, typically, one business day). We may suggest
49+
some changes or improvements or alternatives.
50+
51+
Some things that will increase the chance that your pull request is accepted:
52+
53+
* Write tests.
54+
* Write a [good commit message][commit].
55+
56+
[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

‎Makefile

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
ifeq (run,$(firstword $(MAKECMDGOALS)))
2+
# use the rest as arguments for "run"
3+
RUN_ARGS := $(wordlist 2,$(words $(MAKECMDGOALS)),$(MAKECMDGOALS))
4+
# ...and turn them into do-nothing targets
5+
$(eval $(RUN_ARGS):;@:)
6+
endif
7+
8+
.PHONY: help
9+
10+
help:
11+
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
12+
13+
build: ## creates binary
14+
go build .
15+
install: build ## compiles and installs into system
16+
sudo cp mach /usr/local/bin/magento
17+
sudo chmod +x /usr/local/bin/magento
18+
run: ## run the command through go, accepts args i.e. `make run -- build -h`
19+
go run ./main.go $(RUN_ARGS)
20+
test: build
21+
go test --cover ./...
22+
coverage: build ## run test suite suitable for codecov.io
23+
go test -race -coverprofile=coverage.txt -covermode=atomic ./...
24+
lcov: coverage ## lcov formatted test files for ide interpretation
25+
mkdir -p coverage
26+
gcov2lcov -infile=coverage.txt -outfile=coverage/lcov-vscode.info
27+
lcov-deps: ## install dependancies for gcov2lcov
28+
go get -u github.com/jandelgado/gcov2lcov

‎README.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,14 @@
11
# magento-cli
2-
running magento and adobe commerce locally with a cli tool
2+
3+
[Website](https://superterran.net/magento-cli) |
4+
[Discussions](https://github.com/superterran/magento-cli/discussions) |
5+
[Documentation](https://github.com/superterran/magento-cli/wiki) |
6+
[Twitter](https://twitter.com/superterran) |
7+
[Contribution Guide](CONTRIBUTING.md)
8+
9+
Running magento and adobe commerce locally with a cli tool
10+
11+
[![GoDoc](https://godoc.org/github.com/gohugoio/hugo?status.svg)](https://pkg.go.dev/github.com/superterran/magento-cli)
12+
[![Go](https://github.com/superterran/mach/actions/workflows/go.yml/badge.svg?branch=main)](https://github.com/superterran/magento-cli/actions/workflows/go.yml)
13+
[![Go Report Card](https://goreportcard.com/badge/github.com/superterran/mach)](https://goreportcard.com/report/github.com/superterran/magneto-cli)
14+
[![codecov](https://codecov.io/gh/superterran/mach/branch/main/graph/badge.svg?token=S48U2MJP9I)](https://codecov.io/gh/superterran/magento-cli)

0 commit comments

Comments
 (0)