Enrich the doc so that Marmot looks more friendly to new user. #231
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
| # .github/workflows/release.yaml | |
| name: Release | |
| on: | |
| release: | |
| types: [created] | |
| push: | |
| branches: [master] | |
| pull_request: | |
| types: | |
| - opened | |
| - synchronize | |
| - reopened | |
| jobs: | |
| linux-build: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| include: | |
| - arch: amd64 | |
| cc: gcc | |
| - arch: amd64 | |
| cc: gcc | |
| static: true | |
| - arch: arm64 | |
| cc: aarch64-linux-gnu-gcc | |
| - arch: arm64 | |
| cc: aarch64-linux-gnu-gcc | |
| static: true | |
| - arch: arm | |
| arm: 6 | |
| cc: arm-linux-gnueabi-gcc | |
| - arch: arm | |
| arm: 6 | |
| cc: arm-linux-gnueabi-gcc | |
| static: true | |
| - arch: arm | |
| arm: 7 | |
| cc: arm-linux-gnueabihf-gcc | |
| - arch: arm | |
| arm: 7 | |
| cc: arm-linux-gnueabihf-gcc | |
| static: true | |
| env: | |
| GOOS: linux | |
| GOARCH: ${{ matrix.arch }} | |
| GOARM: ${{ matrix.arm }} | |
| CC: ${{ matrix.cc }} | |
| LDFLAGS: ${{ matrix.static && '-extldflags "-static"' || '' }} | |
| SUFFIX: "${{ matrix.static && '-static' || ''}}" | |
| VERSION: "${{ github.event_name == 'release' && github.event.release.name || github.sha }}" | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-go@v4 | |
| with: | |
| go-version: '^1.21.3' | |
| - name: Install cross-compilers | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y gcc-aarch64-linux-gnu gcc-arm-linux-gnueabihf gcc-arm-linux-gnueabi | |
| - name: Build marmot | |
| run: | | |
| CGO_ENABLED=1 go build -ldflags "-s -w ${{ env.LDFLAGS }}" -o marmot . | |
| tar -czvf marmot-${{ env.VERSION }}-${{ env.GOOS }}-${{ env.GOARCH }}${{ env.GOARM }}${{ env.SUFFIX }}.tar.gz marmot config.toml LICENSE README.md examples/* | |
| - name: Upload binary artifact | |
| uses: actions/upload-artifact@v2 | |
| with: | |
| name: marmot-${{ env.VERSION }}-${{ env.GOOS }}-${{ env.GOARCH }}${{ env.GOARM }}${{ env.SUFFIX }}.tar.gz | |
| path: marmot-${{ env.VERSION }}-${{ env.GOOS }}-${{ env.GOARCH }}${{ env.GOARM }}${{ env.SUFFIX }}.tar.gz | |
| if-no-files-found: error | |
| - name: Get release | |
| id: release | |
| uses: bruceadams/[email protected] | |
| if: github.event_name == 'release' | |
| env: | |
| GITHUB_TOKEN: ${{ github.token }} | |
| - name: Upload release tarball | |
| uses: actions/[email protected] | |
| if: github.event_name == 'release' | |
| env: | |
| GITHUB_TOKEN: ${{ github.token }} | |
| with: | |
| upload_url: ${{ steps.release.outputs.upload_url }} | |
| asset_path: marmot-${{ env.VERSION }}-${{ env.GOOS }}-${{ env.GOARCH }}${{ env.GOARM }}${{ env.SUFFIX }}.tar.gz | |
| asset_name: marmot-${{ env.VERSION }}-${{ env.GOOS }}-${{ env.GOARCH }}${{ env.GOARM }}${{ env.SUFFIX }}.tar.gz | |
| asset_content_type: application/gzip | |
| mac-build: | |
| runs-on: macos-latest | |
| strategy: | |
| matrix: | |
| include: | |
| - arch: arm64 | |
| cc: gcc | |
| - arch: amd64 | |
| cc: gcc | |
| env: | |
| GOOS: darwin | |
| GOARCH: ${{ matrix.arch }} | |
| CC: ${{ matrix.cc }} | |
| LDFLAGS: ${{ matrix.static && '-extldflags "-static"' || '' }} | |
| SUFFIX: "${{ matrix.static && '-static' || ''}}" | |
| VERSION: "${{ github.event_name == 'release' && github.event.release.name || github.sha }}" | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-go@v4 | |
| with: | |
| go-version: '^1.21.3' | |
| - name: Build marmot | |
| run: | | |
| CGO_ENABLED=1 go build -o marmot . | |
| tar -czvf marmot-${{ env.VERSION }}-${{ env.GOOS }}-${{ env.GOARCH }}${{ env.SUFFIX }}.tar.gz marmot config.toml LICENSE README.md examples/* | |
| - name: Upload binary artifact | |
| uses: actions/upload-artifact@v2 | |
| with: | |
| name: marmot-${{ env.VERSION }}-${{ env.GOOS }}-${{ env.GOARCH }}${{ env.SUFFIX }}.tar.gz | |
| path: marmot-${{ env.VERSION }}-${{ env.GOOS }}-${{ env.GOARCH }}${{ env.SUFFIX }}.tar.gz | |
| if-no-files-found: error | |
| - name: Get release | |
| id: release | |
| uses: bruceadams/[email protected] | |
| if: github.event_name == 'release' | |
| env: | |
| GITHUB_TOKEN: ${{ github.token }} | |
| - name: Upload release tarball | |
| uses: actions/[email protected] | |
| if: github.event_name == 'release' | |
| env: | |
| GITHUB_TOKEN: ${{ github.token }} | |
| with: | |
| upload_url: ${{ steps.release.outputs.upload_url }} | |
| asset_path: marmot-${{ env.VERSION }}-${{ env.GOOS }}-${{ env.GOARCH }}${{ env.SUFFIX }}.tar.gz | |
| asset_name: marmot-${{ env.VERSION }}-${{ env.GOOS }}-${{ env.GOARCH }}${{ env.SUFFIX }}.tar.gz | |
| asset_content_type: application/gzip |