From e9a4d68963f1ef65d265b5628f9f178215474710 Mon Sep 17 00:00:00 2001 From: CHIKAMATSU Naohiro Date: Wed, 1 May 2024 22:26:16 +0900 Subject: [PATCH 1/4] docs: add @nao1215 as a contributor --- .all-contributorsrc | 25 +++++++++++++++++++++++++ README.md | 42 ++++++++++++++++++++++++++++++++++++++---- 2 files changed, 63 insertions(+), 4 deletions(-) create mode 100644 .all-contributorsrc diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 0000000..7592260 --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,25 @@ +{ + "projectName": "mimixbox", + "projectOwner": "nao1215", + "repoType": "github", + "repoHost": "https://github.com", + "files": [ + "README.md" + ], + "imageSize": 75, + "commit": true, + "commitConvention": "angular", + "contributors": [ + { + "login": "nao1215", + "name": "CHIKAMATSU Naohiro", + "avatar_url": "https://avatars.githubusercontent.com/u/22737008?v=4", + "profile": "https://debimate.jp/", + "contributions": [ + "code" + ] + } + ], + "contributorsPerLine": 7, + "linkToUsage": true +} diff --git a/README.md b/README.md index bba3961..1e87642 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@
+ +[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) +
@@ -19,18 +22,18 @@ Also, the MimixBox project maintainer plan to have a wide range of built-in comm The source code and binaries are distributed on [the Release Page](https://github.com/nao1215/mimixbox/releases) in ZIP format and tar.gz format. Choose the binary that suits your OS and CPU architecture. For example, in the case of Linux (amd64), you can install the MimixBox and documents on your system with the following command: -``` +```shell $ tar xf mimixbox-0.30.0-linux-amd64.tar.gz $ cd mimixbox-0.30.0-linux-amd64 $ sudo ./installer.sh ``` -If you have a Golang development environment, you can also install it by the following method. This method does not install the documentation. - -``` +## Use "go install" +```shell $ go install github.com/nao1215/mimixbox/cmd/mimixbox@latest $ sudo mimixbox --install /usr/local/bin ``` + # Development ## Tools & Libraries The table below shows the tools used when developing the commands in the MimixBox project. @@ -118,3 +121,34 @@ We are also looking forward to sponsorship. # LICENSE The MimixBox project is licensed under the terms of the MIT license and Apache License 2.0. See [LICENSE](./LICENSE) and [NOTICE](./NOTICE) + +## Contributors ✨ + +Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): + + + + + + + + + + + + + + + +
CHIKAMATSU Naohiro
CHIKAMATSU Naohiro
💻
+ + Add your contributions + +
+ + + + + + +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! \ No newline at end of file From eff061874147b238902320b17ad3a920773e220c Mon Sep 17 00:00:00 2001 From: CHIKAMATSU Naohiro Date: Wed, 1 May 2024 22:26:58 +0900 Subject: [PATCH 2/4] docs: add @polynomialspace as a contributor --- .all-contributorsrc | 9 +++++++++ README.md | 3 ++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/.all-contributorsrc b/.all-contributorsrc index 7592260..4988802 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -18,6 +18,15 @@ "contributions": [ "code" ] + }, + { + "login": "polynomialspace", + "name": "polynomialspace", + "avatar_url": "https://avatars.githubusercontent.com/u/45617594?v=4", + "profile": "https://github.com/polynomialspace", + "contributions": [ + "code" + ] } ], "contributorsPerLine": 7, diff --git a/README.md b/README.md index 1e87642..7f6c887 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@
-[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) +[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
@@ -133,6 +133,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d CHIKAMATSU Naohiro
CHIKAMATSU Naohiro
💻 + polynomialspace
polynomialspace
💻 From fbdfefe849b36c6ddc2b90007379b94c10778a85 Mon Sep 17 00:00:00 2001 From: CHIKAMATSU Naohiro Date: Wed, 1 May 2024 22:27:21 +0900 Subject: [PATCH 3/4] docs: add @k-avy as a contributor --- .all-contributorsrc | 9 +++++++++ README.md | 3 ++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/.all-contributorsrc b/.all-contributorsrc index 4988802..c878e2b 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -27,6 +27,15 @@ "contributions": [ "code" ] + }, + { + "login": "k-avy", + "name": "Kavya Shukla", + "avatar_url": "https://avatars.githubusercontent.com/u/81437739?v=4", + "profile": "https://github.com/k-avy", + "contributions": [ + "code" + ] } ], "contributorsPerLine": 7, diff --git a/README.md b/README.md index 7f6c887..23ebad1 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@
-[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-) +[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
@@ -134,6 +134,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d CHIKAMATSU Naohiro
CHIKAMATSU Naohiro
💻 polynomialspace
polynomialspace
💻 + Kavya Shukla
Kavya Shukla
💻 From 40bb14019ceb01cf2ea7cfd63b8520590e0bfbdc Mon Sep 17 00:00:00 2001 From: CHIKAMATSU Naohiro Date: Wed, 1 May 2024 22:27:47 +0900 Subject: [PATCH 4/4] Introduce homebrew and update project setting --- .github/dependabot.yml | 5 +++++ .github/workflows/build.yml | 5 +++-- .github/workflows/integration_test.yml | 5 +++-- .github/workflows/release.yml | 5 +++-- .github/workflows/unit_test.yml | 6 +++--- .goreleaser.yml | 29 ++++++++++++++++++++++---- 6 files changed, 42 insertions(+), 13 deletions(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index ac6b3cc..5463252 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -6,3 +6,8 @@ updates: interval: daily time: "20:00" open-pull-requests-limit: 10 + # Maintain dependencies for GitHub Actions + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "daily" diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index d2dffd5..914a875 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -13,9 +13,10 @@ jobs: - uses: actions/checkout@v2 - name: Set up Go - uses: actions/setup-go@v2 + uses: actions/setup-go@v5 with: - go-version: "1.18" + go-version: "1" + check-latest: true - name: Build run: make build diff --git a/.github/workflows/integration_test.yml b/.github/workflows/integration_test.yml index 3786702..177b86d 100644 --- a/.github/workflows/integration_test.yml +++ b/.github/workflows/integration_test.yml @@ -14,9 +14,10 @@ jobs: - uses: actions/checkout@v2 - name: Set up Go - uses: actions/setup-go@v2 + uses: actions/setup-go@v5 with: - go-version: "1.18" + go-version: "1" + check-latest: true - name: SetupShellScript run: curl -fsSL https://git.io/shellspec | sh -s -- --yes diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index f26bd1e..b3eaebc 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -15,9 +15,10 @@ jobs: with: fetch-depth: 0 - name: Setup Go - uses: actions/setup-go@v2 + uses: actions/setup-go@v5 with: - go-version: "1.18" + go-version: "1" + check-latest: true - name: Run GoReleaser uses: goreleaser/goreleaser-action@v2 with: diff --git a/.github/workflows/unit_test.yml b/.github/workflows/unit_test.yml index 5937bc7..1fad3dc 100644 --- a/.github/workflows/unit_test.yml +++ b/.github/workflows/unit_test.yml @@ -12,10 +12,10 @@ jobs: steps: - uses: actions/checkout@v2 - - name: Set up Go - uses: actions/setup-go@v2 + - uses: actions/setup-go@v5 with: - go-version: "1.18" + go-version: "1" + check-latest: true - name: UnitTest run: make ut diff --git a/.goreleaser.yml b/.goreleaser.yml index 4573b0a..dfcd477 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -13,12 +13,16 @@ builds: - CGO_ENABLED=0 goos: - linux + - windows + - darwin + goarch: + - amd64 + - arm64 archives: - name_template: "{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}" - replacements: - linux: Linux - 386: i386 - amd64: x86_64 + format_overrides: + - goos: windows + format: zip checksum: name_template: "checksums.txt" snapshot: @@ -29,3 +33,20 @@ changelog: exclude: - "^docs:" - "^test:" +nfpms: + - maintainer: Naohiro CHIKAMATSU + description: MimixBox - mimic BusyBox on Linux + homepage: https://github.com/nao1215/mimixbox + license: Apache-2.0 license + formats: + - deb + - rpm + - apk +brews: + - name: mimixbox + description: MimixBox - mimic BusyBox on Linux + license: Apache-2.0 license + repository: + owner: nao1215 + name: homebrew-tap + token: "{{ .Env.TAP_GITHUB_TOKEN }}"