From fd32275f702ba37b81375c458f0f2254352c6387 Mon Sep 17 00:00:00 2001 From: sammyette <38820196+TorchedSammy@users.noreply.github.com> Date: Thu, 20 May 2021 17:47:22 -0400 Subject: [PATCH 01/15] ci: add github actions workflow to build on commit --- .github/workflows/build.yml | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 .github/workflows/build.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..b694fd3 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,35 @@ +on: + push: + branches: + - master + - dev + pull_request: + branches: + - dev + +jobs: + build: + name: Build + runs-on: ubuntu-latest + strategy: + matrix: + # build and publish in parallel: linux/386, linux/amd64, windows/386, windows/amd64, darwin/amd64 + goos: + - linux + - windows + - darwin + goarch: + - "386" + - amd64 + exclude: + - goarch: "386" + goos: darwin + steps: + - uses: actions/checkout@v2 + - uses: wangyoucao577/go-release-action@v1.17 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + goos: ${{ matrix.goos }} + goarch: ${{ matrix.goarch }} + extra_files: LICENSE README.md + asset_name: hilbish-${{ matrix.goos }}-${{ matrix.goarch }} From b9864ce4c6621d7c043bf97cacf739d8bff00e27 Mon Sep 17 00:00:00 2001 From: sammyette <38820196+TorchedSammy@users.noreply.github.com> Date: Thu, 20 May 2021 18:03:28 -0400 Subject: [PATCH 02/15] ci: try to build for linux only and install readline before --- .github/workflows/build.yml | 53 ++++++++++++++++++++----------------- 1 file changed, 28 insertions(+), 25 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index b694fd3..75f11cb 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -8,28 +8,31 @@ on: - dev jobs: - build: - name: Build - runs-on: ubuntu-latest - strategy: - matrix: - # build and publish in parallel: linux/386, linux/amd64, windows/386, windows/amd64, darwin/amd64 - goos: - - linux - - windows - - darwin - goarch: - - "386" - - amd64 - exclude: - - goarch: "386" - goos: darwin - steps: - - uses: actions/checkout@v2 - - uses: wangyoucao577/go-release-action@v1.17 - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - goos: ${{ matrix.goos }} - goarch: ${{ matrix.goarch }} - extra_files: LICENSE README.md - asset_name: hilbish-${{ matrix.goos }}-${{ matrix.goarch }} + build: + name: Build + runs-on: ubuntu-latest + strategy: + matrix: + include: + # build and publish in parallel: linux/386, linux/amd64, windows/386, windows/amd64, darwin/amd64 + - goos: linux + os: ubuntu-latest +# - windows +# - darwin + goarch: + - amd64 + exclude: + - goarch: "386" + goos: darwin + steps: + - name: Install readline + run: sudo apt install libreadline-dev + - uses: actions/checkout@v2 + - uses: wangyoucao577/go-release-action@v1.17 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + goos: ${{ matrix.goos }} + goarch: ${{ matrix.goarch }} + extra_files: LICENSE README.md + asset_name: hilbish-${{ matrix.goos }}-${{ matrix.goarch }} + From d3989e09ed6bd3bfbc546f9fd54b7520f01d1842 Mon Sep 17 00:00:00 2001 From: sammyette <38820196+TorchedSammy@users.noreply.github.com> Date: Thu, 20 May 2021 18:04:29 -0400 Subject: [PATCH 03/15] ci: use matrix.os for runs-on --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 75f11cb..b0eeb4f 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -10,7 +10,7 @@ on: jobs: build: name: Build - runs-on: ubuntu-latest + runs-on: ${{ matrix.os }} strategy: matrix: include: From 92f9e51a15f4cc48e5a6742692fcf6e7edb5153f Mon Sep 17 00:00:00 2001 From: sammyette <38820196+TorchedSammy@users.noreply.github.com> Date: Thu, 20 May 2021 18:05:56 -0400 Subject: [PATCH 04/15] chore(ci): use spaces instead of tabs --- .github/workflows/build.yml | 54 ++++++++++++++++++------------------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index b0eeb4f..9b1d7a0 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -8,31 +8,31 @@ on: - dev jobs: - build: - name: Build - runs-on: ${{ matrix.os }} - strategy: - matrix: - include: - # build and publish in parallel: linux/386, linux/amd64, windows/386, windows/amd64, darwin/amd64 - - goos: linux - os: ubuntu-latest -# - windows -# - darwin - goarch: - - amd64 - exclude: - - goarch: "386" - goos: darwin - steps: - - name: Install readline - run: sudo apt install libreadline-dev - - uses: actions/checkout@v2 - - uses: wangyoucao577/go-release-action@v1.17 - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - goos: ${{ matrix.goos }} - goarch: ${{ matrix.goarch }} - extra_files: LICENSE README.md - asset_name: hilbish-${{ matrix.goos }}-${{ matrix.goarch }} + build: + name: Build + runs-on: ${{ matrix.os }} + strategy: + matrix: + include: + # build and publish in parallel: linux/386, linux/amd64, windows/386, windows/amd64, darwin/amd64 + - goos: linux + os: ubuntu-latest +# - windows +# - darwin + goarch: + - amd64 + exclude: + - goarch: "386" + goos: darwin + steps: + - name: Install readline + run: sudo apt install libreadline-dev + - uses: actions/checkout@v2 + - uses: wangyoucao577/go-release-action@v1.17 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + goos: ${{ matrix.goos }} + goarch: ${{ matrix.goarch }} + extra_files: LICENSE README.md + asset_name: hilbish-${{ matrix.goos }}-${{ matrix.goarch }} From bbec5c3c14a87d815b597343666abb8d65bd4919 Mon Sep 17 00:00:00 2001 From: sammyette <38820196+TorchedSammy@users.noreply.github.com> Date: Thu, 20 May 2021 18:06:56 -0400 Subject: [PATCH 05/15] ci: fix syntax errors --- .github/workflows/build.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 9b1d7a0..f8f0dc7 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -19,9 +19,9 @@ jobs: os: ubuntu-latest # - windows # - darwin - goarch: + - goarch: - amd64 - exclude: + - exclude: - goarch: "386" goos: darwin steps: From 88f750f546ea03770d0805d6e85f040175c07f2a Mon Sep 17 00:00:00 2001 From: sammyette <38820196+TorchedSammy@users.noreply.github.com> Date: Thu, 20 May 2021 18:08:55 -0400 Subject: [PATCH 06/15] ci: go back to old action file --- .github/workflows/build.yml | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index f8f0dc7..43f63d4 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -10,20 +10,20 @@ on: jobs: build: name: Build - runs-on: ${{ matrix.os }} + runs-on: ubuntu-latest strategy: matrix: - include: # build and publish in parallel: linux/386, linux/amd64, windows/386, windows/amd64, darwin/amd64 - - goos: linux - os: ubuntu-latest -# - windows -# - darwin - - goarch: - - amd64 - - exclude: - - goarch: "386" - goos: darwin + goos: + - linux +# - windows +# - darwin + goarch: + - "386" + - amd64 + exclude: + - goarch: "386" + goos: darwin steps: - name: Install readline run: sudo apt install libreadline-dev @@ -35,4 +35,3 @@ jobs: goarch: ${{ matrix.goarch }} extra_files: LICENSE README.md asset_name: hilbish-${{ matrix.goos }}-${{ matrix.goarch }} - From aadb5f373cdc9022e55b3ea3c94e4edb730f504b Mon Sep 17 00:00:00 2001 From: sammyette <38820196+TorchedSammy@users.noreply.github.com> Date: Thu, 20 May 2021 18:10:50 -0400 Subject: [PATCH 07/15] chore(ci): removed github action - say goodbye to ci --- .github/workflows/build.yml | 37 ------------------------------------- 1 file changed, 37 deletions(-) delete mode 100644 .github/workflows/build.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml deleted file mode 100644 index 43f63d4..0000000 --- a/.github/workflows/build.yml +++ /dev/null @@ -1,37 +0,0 @@ -on: - push: - branches: - - master - - dev - pull_request: - branches: - - dev - -jobs: - build: - name: Build - runs-on: ubuntu-latest - strategy: - matrix: - # build and publish in parallel: linux/386, linux/amd64, windows/386, windows/amd64, darwin/amd64 - goos: - - linux -# - windows -# - darwin - goarch: - - "386" - - amd64 - exclude: - - goarch: "386" - goos: darwin - steps: - - name: Install readline - run: sudo apt install libreadline-dev - - uses: actions/checkout@v2 - - uses: wangyoucao577/go-release-action@v1.17 - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - goos: ${{ matrix.goos }} - goarch: ${{ matrix.goarch }} - extra_files: LICENSE README.md - asset_name: hilbish-${{ matrix.goos }}-${{ matrix.goarch }} From 35c0a0d38643dd1b6357d06b7be23c8e0df26219 Mon Sep 17 00:00:00 2001 From: sammyette <38820196+TorchedSammy@users.noreply.github.com> Date: Thu, 20 May 2021 18:18:14 -0400 Subject: [PATCH 08/15] ci: experiment with slightly changed build file - say hi again --- .github/workflows/build.yml | 39 +++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 .github/workflows/build.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..cfbb57b --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,39 @@ +on: + push: + branches: + - master + - dev + pull_request: + branches: + - dev + +jobs: + build: + name: Build + runs-on: ubuntu-latest + strategy: + matrix: + # build and publish in parallel: linux/386, linux/amd64, windows/386, windows/amd64, darwin/amd64 + goos: + - linux +# - windows +# - darwin + goarch: + - "386" + - amd64 + exclude: + - goarch: "386" + goos: darwin + steps: + - name: Install readline + run: sudo apt install libreadline-dev + - uses: actions/checkout@v2 + - uses: wangyoucao577/go-release-action@v1.17 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + goos: ${{ matrix.goos }} + goarch: ${{ matrix.goarch }} + extra_files: LICENSE README.md + asset_name: hilbish-${{ matrix.goos }}-${{ matrix.goarch }} + ldflags: -tags hilbiline + pre_command: go get -d From c277c677869133c80d5c633dfadf3fc11cad2cdf Mon Sep 17 00:00:00 2001 From: sammyette <38820196+TorchedSammy@users.noreply.github.com> Date: Thu, 20 May 2021 18:19:54 -0400 Subject: [PATCH 09/15] ci: use build_flags instead --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index cfbb57b..e179f82 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -35,5 +35,5 @@ jobs: goarch: ${{ matrix.goarch }} extra_files: LICENSE README.md asset_name: hilbish-${{ matrix.goos }}-${{ matrix.goarch }} - ldflags: -tags hilbiline + build_flags: -tags hilbiline pre_command: go get -d From 571764a87f6342fa02eadc9174644b353421f7be Mon Sep 17 00:00:00 2001 From: sammyette <38820196+TorchedSammy@users.noreply.github.com> Date: Thu, 20 May 2021 18:29:32 -0400 Subject: [PATCH 10/15] ci: just build instead of trying to make release --- .github/workflows/build.yml | 53 ++++++++++++++----------------------- 1 file changed, 20 insertions(+), 33 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index e179f82..e23168b 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -1,39 +1,26 @@ -on: - push: - branches: - - master - - dev - pull_request: - branches: - - dev +name: Build + +on: + - push + - pull_request jobs: build: - name: Build - runs-on: ubuntu-latest + name: ${{ matrix.build }} + runs-on: ${{ matrix.os }} strategy: matrix: - # build and publish in parallel: linux/386, linux/amd64, windows/386, windows/amd64, darwin/amd64 - goos: - - linux -# - windows -# - darwin - goarch: - - "386" - - amd64 - exclude: - - goarch: "386" - goos: darwin + include: + - build: linux-amd64 + os: ubuntu-latest + - build: darwin-amd64 + os: macOS-latest + steps: - - name: Install readline - run: sudo apt install libreadline-dev - - uses: actions/checkout@v2 - - uses: wangyoucao577/go-release-action@v1.17 - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - goos: ${{ matrix.goos }} - goarch: ${{ matrix.goarch }} - extra_files: LICENSE README.md - asset_name: hilbish-${{ matrix.goos }}-${{ matrix.goarch }} - build_flags: -tags hilbiline - pre_command: go get -d + - name: Checkout sources + uses: actions/checkout@v2 + - name: Setup Go + uses: actions/setup-go@v2 + - name: Build + run: make hilbiline + From 9e5dbfc7e0a6802e2de1f3d757f45bd13add59ca Mon Sep 17 00:00:00 2001 From: sammyette <38820196+TorchedSammy@users.noreply.github.com> Date: Thu, 20 May 2021 18:31:30 -0400 Subject: [PATCH 11/15] ci: use latest go version --- .github/workflows/build.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index e23168b..1f1e9ba 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -21,6 +21,8 @@ jobs: uses: actions/checkout@v2 - name: Setup Go uses: actions/setup-go@v2 + with: + go-version: '1.16.2' - name: Build run: make hilbiline From 439930a6536e42b909fccc2b8b214863b5105b8d Mon Sep 17 00:00:00 2001 From: sammyette <38820196+TorchedSammy@users.noreply.github.com> Date: Thu, 20 May 2021 18:36:36 -0400 Subject: [PATCH 12/15] ci: upload artifact of compiled binary --- .github/workflows/build.yml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 1f1e9ba..bb65666 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -13,9 +13,6 @@ jobs: include: - build: linux-amd64 os: ubuntu-latest - - build: darwin-amd64 - os: macOS-latest - steps: - name: Checkout sources uses: actions/checkout@v2 @@ -25,4 +22,8 @@ jobs: go-version: '1.16.2' - name: Build run: make hilbiline + - uses: actions/upload-artifact@v2 + with: + name: hilbish-${{ matrix.build }} + path: hilbish From 1f3162fc4f57c6da6dc5c488e924cb81e0f4fc39 Mon Sep 17 00:00:00 2001 From: sammyette <38820196+TorchedSammy@users.noreply.github.com> Date: Thu, 20 May 2021 18:48:16 -0400 Subject: [PATCH 13/15] ci: set fetch depth to 0 --- .github/workflows/build.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index bb65666..b90b97f 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -16,6 +16,8 @@ jobs: steps: - name: Checkout sources uses: actions/checkout@v2 + with: + fetch-depth: 0 - name: Setup Go uses: actions/setup-go@v2 with: From 459606618ceba14581517654d1039a8269951102 Mon Sep 17 00:00:00 2001 From: sammyette <38820196+TorchedSammy@users.noreply.github.com> Date: Thu, 20 May 2021 19:11:07 -0400 Subject: [PATCH 14/15] docs: add that precompiled binaries are provided, more details in install --- README.md | 33 ++++++++++++++++++++++++++------- 1 file changed, 26 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 9bc1ccf..9dbe346 100644 --- a/README.md +++ b/README.md @@ -25,16 +25,27 @@ but there may still be breaking changes in Lua modules. - **[Gallery](https://github.com/Hilbis/Hilbish/discussions/36)** - See more screenshots of Hilbish in action -# Building -Prebuilt binaries are not yet provided, so to try it out you'll have to manually compile. - +# Installation **NOTE:** Hilbish is currently only officially supported and tested on Linux -### Prerequisites +### Prebuilt binaries +Binaries are provided for the latest commit. + +**Note that these use Hilbiline, not readline, and may be missing functionality +(moving the cursor, proper unicode support and backspace working properly)** + +Click on the checkmark (or x) near the commit hash, then details for your platform +

+ +Then click on the artifacts drop down, and download artifact for your platform, +like what is highlighted in the screenshot. +

+ +### Manual Build +#### Prerequisites - [Go 1.16](https://go.dev) - GNU Readline - On Fedora, readline can be installed with: ``` sudo dnf install readline-devel @@ -50,14 +61,19 @@ On OpenSUSE, it can be installed with: sudo zypper install readline-devel ``` -### Install +#### Install First, clone Hilbish: ```sh git clone --recursive https://github.com/Hilbis/Hilbish cd Hilbish ``` -Then build and install: +And get dependencies: +```sh +go get -d +``` + +then, build and install: ```sh make dev sudo make install @@ -72,6 +88,9 @@ make build sudo make install ``` +If you want to use Hilbiline instead, replace `make dev`/`make build` with `make hilbiline`. +`make build all` will still try to use readline. + Alternatively, if you use Arch Linux, you can compile Hilbish with an **(unofficial)** AUR package: ```sh yay -S hilbish From 7aa9fb9fe658168ac431a6e8169d882c4ab6cb76 Mon Sep 17 00:00:00 2001 From: sammyette <38820196+TorchedSammy@users.noreply.github.com> Date: Thu, 20 May 2021 19:21:28 -0400 Subject: [PATCH 15/15] docs: shorten/simplify build steps --- README.md | 27 +++++++++------------------ 1 file changed, 9 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 9dbe346..c26f7f0 100644 --- a/README.md +++ b/README.md @@ -61,35 +61,26 @@ On OpenSUSE, it can be installed with: sudo zypper install readline-devel ``` -#### Install +#### Build First, clone Hilbish: ```sh git clone --recursive https://github.com/Hilbis/Hilbish cd Hilbish +# If you want the latest stable release, run this following command +git checkout $(git describe --tags `git rev-list --tags --max-count=1`) ``` -And get dependencies: +And get dependencies and build: ```sh go get -d -``` - -then, build and install: -```sh make dev -sudo make install -# Or -sudo make all -``` - -Or, if you want the latest stable release: -``` -git checkout $(git describe --tags `git rev-list --tags --max-count=1`) +# If you want to use latest stable release, make build -sudo make install +# or want to use Hilbiline, +make hilbiline ``` - -If you want to use Hilbiline instead, replace `make dev`/`make build` with `make hilbiline`. -`make build all` will still try to use readline. +#### Install +`sudo make install` Alternatively, if you use Arch Linux, you can compile Hilbish with an **(unofficial)** AUR package: ```sh