README: fix typo (#452) #119
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
name: nightly build | |
on: | |
push: | |
branches: | |
- master | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Check out | |
uses: actions/checkout@v4 | |
with: | |
submodules: recursive | |
- name: Build | |
run: | | |
pkgver=nightly-$(date +'%Y%m%d')+$(git rev-parse --short HEAD) | |
echo "blesh_build_pkgver=$pkgver" >> "$GITHUB_ENV" | |
make FULLVER="0.4.0-nightly" | |
sed -i "s/^_ble_base_repository=.*/_ble_base_repository=release:$pkgver/" "out/ble.sh" | |
- name: Test | |
run: make check | |
- name: Package | |
run: | | |
make install INSDIR="./ble-${{ env.blesh_build_pkgver }}" | |
tar -cJf "ble-${{ env.blesh_build_pkgver }}.tar.xz" "ble-${{ env.blesh_build_pkgver }}" | |
mv "ble-${{ env.blesh_build_pkgver }}" ble-nightly | |
tar -cJf ble-nightly.tar.xz ble-nightly | |
- name: Release | |
uses: softprops/action-gh-release@v2 | |
with: | |
files: | | |
ble-nightly.tar.xz | |
ble-${{ env.blesh_build_pkgver }}.tar.xz | |
tag_name: nightly | |
prerelease: true | |
body: | | |
## Usage | |
**Prerequisites** | |
Bash 3.0+ and basic POSIX utilities are required. | |
**Download ble-nightly.tar.xz** | |
Link kept updated for every nightly build: | |
${{ github.event.repository.url }}/releases/download/nightly/ble-nightly.tar.xz | |
Permalink to the current nightly build: | |
${{ github.event.repository.url }}/releases/download/nightly/ble-${{ env.blesh_build_pkgver }}.tar.xz | |
```bash | |
# DOWNLOAD with wget | |
wget ${{ github.event.repository.url }}/releases/download/nightly/ble-nightly.tar.xz | |
# DOWNLOAD with curl | |
curl -LO ${{ github.event.repository.url }}/releases/download/nightly/ble-nightly.tar.xz | |
# DOWNLOAD with wget (this specific nightly build) | |
wget ${{ github.event.repository.url }}/releases/download/nightly/ble-${{ env.blesh_build_pkgver }}.tar.xz | |
# DOWNLOAD with curl (this specific nightly build) | |
curl -LO ${{ github.event.repository.url }}/releases/download/nightly/ble-${{ env.blesh_build_pkgver }}.tar.xz | |
``` | |
**Trial & Install** | |
```bash | |
# TRIAL | |
tar xJf ble-nightly.tar.xz | |
source ble-nightly/ble.sh | |
# INSTALL (quick) | |
tar xJf ble-nightly.tar.xz | |
bash ble-nightly/ble.sh --install ~/.local/share | |
echo 'source ~/.local/share/blesh' >> ~/.bashrc | |
# Note: After installation, directory ble-${{ env.blesh_build_pkgver }} can be removed. | |
# INSTALL (more robust) | |
tar xJf ble-nightly.tar.xz | |
bash ble-nightly/ble.sh --install ~/.local/share | |
# Add the following line near the top of ~/.bashrc | |
[[ $- == *i* ]] && source ~/.local/share/blesh/ble.sh --attach=none | |
# Add the following line at the end of ~/.bashrc | |
[[ ${BLE_VERSION-} ]] && ble-attach | |
# Note: After installation, directory ble-${{ env.blesh_build_pkgver }} can be removed. | |
``` | |
check: | |
needs: build | |
strategy: | |
matrix: | |
os: [macos-latest, windows-latest] | |
runs-on: ${{ matrix.os }} | |
steps: | |
- name: Check out | |
uses: actions/checkout@v4 | |
with: | |
submodules: recursive | |
- name: Install dependencies | |
if: runner.os == 'macOs' | |
run: brew install gawk | |
- name: Build | |
run: make | |
- name: Test | |
run: make check |