@@ -0,0 +1,287 @@
1+name: CICD
2+
3+env:
4+ PROJECT_NAME: bat
5+ PROJECT_DESC: "A `cat` clone with wings"
6+ PROJECT_AUTH: "sharkdp"
7+ RUST_MIN_SRV: "1.40.0"
8+
9+on: [push, pull_request]
10+
11+jobs:
12+ min_version:
13+ name: MinSRV # Minimum supported rust version
14+ runs-on: ubuntu-latest
15+ steps:
16+ - uses: actions/checkout@v1
17+ - name: Install `rust` toolchain (v${{ env.RUST_MIN_SRV }})
18+ uses: actions-rs/toolchain@v1
19+ with:
20+ toolchain: ${{ env.RUST_MIN_SRV }}
21+ default: true
22+ profile: minimal # minimal component installation (ie, no documentation)
23+ - name: Test
24+ uses: actions-rs/cargo@v1
25+ with:
26+ command: test
27+
28+ build:
29+ name: Build
30+ runs-on: ${{ matrix.job.os }}
31+ strategy:
32+ fail-fast: false
33+ matrix:
34+ job:
35+ # { os, target, cargo-options, features, use-cross, toolchain }
36+ - { os: ubuntu-latest , target: arm-unknown-linux-gnueabihf , use-cross: use-cross }
37+ - { os: ubuntu-18.04 , target: aarch64-unknown-linux-gnu , use-cross: use-cross }
38+ - { os: ubuntu-18.04 , target: i586-unknown-linux-gnu , use-cross: use-cross }
39+ - { os: ubuntu-18.04 , target: i686-unknown-linux-gnu , use-cross: use-cross }
40+ - { os: ubuntu-18.04 , target: i686-unknown-linux-musl , use-cross: use-cross }
41+ - { os: ubuntu-18.04 , target: x86_64-unknown-linux-gnu , use-cross: use-cross }
42+ - { os: ubuntu-18.04 , target: x86_64-unknown-linux-musl , use-cross: use-cross }
43+ - { os: ubuntu-16.04 , target: x86_64-unknown-linux-gnu , use-cross: use-cross }
44+ - { os: macos-latest , target: x86_64-apple-darwin }
45+ - { os: windows-latest , target: i686-pc-windows-gnu }
46+ - { os: windows-latest , target: i686-pc-windows-msvc }
47+ - { os: windows-latest , target: x86_64-pc-windows-gnu } ## note: requires rust >= 1.43.0 to link correctly
48+ - { os: windows-latest , target: x86_64-pc-windows-msvc }
49+ steps:
50+ - uses: actions/checkout@v1
51+ - name: Install any prerequisites
52+ shell: bash
53+ run: |
54+ case ${{ matrix.job.target }} in
55+ arm-unknown-linux-gnueabihf) sudo apt-get -y update ; sudo apt-get -y install gcc-arm-linux-gnueabihf ;;
56+ aarch64-unknown-linux-gnu) sudo apt-get -y update ; sudo apt-get -y install gcc-aarch64-linux-gnu ;;
57+ esac
58+ - name: Initialize workflow variables
59+ id: vars
60+ shell: bash
61+ run: |
62+ # toolchain
63+ TOOLCHAIN="stable" ## default to "stable" toolchain
64+ # * specify alternate TOOLCHAIN for *-pc-windows-gnu targets; gnu targets on Windows are broken for the standard *-pc-windows-msvc toolchain (refs: <https://github.com/rust-lang/rust/issues/47048>, <https://github.com/rust-lang/rust/issues/53454>, <https://github.com/rust-lang/cargo/issues/6754>)
65+ case ${{ matrix.job.target }} in *-pc-windows-gnu) TOOLCHAIN="stable-${{ matrix.job.target }}" ;; esac;
66+ # * use requested TOOLCHAIN if specified
67+ if [ -n "${{ matrix.job.toolchain }}" ]; then TOOLCHAIN="${{ matrix.job.toolchain }}" ; fi
68+ echo set-output name=TOOLCHAIN::${TOOLCHAIN}
69+ echo ::set-output name=TOOLCHAIN::${TOOLCHAIN}
70+ # staging directory
71+ STAGING='_staging'
72+ echo set-output name=STAGING::${STAGING}
73+ echo ::set-output name=STAGING::${STAGING}
74+ # determine EXE suffix
75+ EXE_suffix="" ; case ${{ matrix.job.target }} in *-pc-windows-*) EXE_suffix=".exe" ;; esac;
76+ echo set-output name=EXE_suffix::${EXE_suffix}
77+ echo ::set-output name=EXE_suffix::${EXE_suffix}
78+ # parse commit reference info
79+ REF_NAME=${GITHUB_REF#refs/*/}
80+ unset REF_BRANCH ; case ${GITHUB_REF} in refs/heads/*) REF_BRANCH=${GITHUB_REF#refs/heads/} ;; esac;
81+ unset REF_TAG ; case ${GITHUB_REF} in refs/tags/*) REF_TAG=${GITHUB_REF#refs/tags/} ;; esac;
82+ REF_SHAS=${GITHUB_SHA:0:8}
83+ echo set-output name=REF_NAME::${REF_NAME}
84+ echo set-output name=REF_BRANCH::${REF_BRANCH}
85+ echo set-output name=REF_TAG::${REF_TAG}
86+ echo set-output name=REF_SHAS::${REF_SHAS}
87+ echo ::set-output name=REF_NAME::${REF_NAME}
88+ echo ::set-output name=REF_BRANCH::${REF_BRANCH}
89+ echo ::set-output name=REF_TAG::${REF_TAG}
90+ echo ::set-output name=REF_SHAS::${REF_SHAS}
91+ # parse target
92+ unset TARGET_ARCH ; case ${{ matrix.job.target }} in arm-unknown-linux-gnueabihf) TARGET_ARCH=arm ;; i686-*) TARGET_ARCH=i686 ;; x86_64-*) TARGET_ARCH=x86_64 ;; esac;
93+ echo set-output name=TARGET_ARCH::${TARGET_ARCH}
94+ echo ::set-output name=TARGET_ARCH::${TARGET_ARCH}
95+ unset TARGET_OS ; case ${{ matrix.job.target }} in *-linux-*) TARGET_OS=linux ;; *-apple-*) TARGET_OS=macos ;; *-windows-*) TARGET_OS=windows ;; esac;
96+ echo set-output name=TARGET_OS::${TARGET_OS}
97+ echo ::set-output name=TARGET_OS::${TARGET_OS}
98+ # package name
99+ PKG_suffix=".tar.gz" ; case ${{ matrix.job.target }} in *-pc-windows-*) PKG_suffix=".zip" ;; esac;
100+ PKG_BASENAME=${PROJECT_NAME}-${REF_TAG:-$REF_SHAS}-${{ matrix.job.target }}
101+ PKG_NAME=${PKG_BASENAME}${PKG_suffix}
102+ echo set-output name=PKG_suffix::${PKG_suffix}
103+ echo set-output name=PKG_BASENAME::${PKG_BASENAME}
104+ echo set-output name=PKG_NAME::${PKG_NAME}
105+ echo ::set-output name=PKG_suffix::${PKG_suffix}
106+ echo ::set-output name=PKG_BASENAME::${PKG_BASENAME}
107+ echo ::set-output name=PKG_NAME::${PKG_NAME}
108+ # deployable tag? (ie, leading "vM" or "M"; M == version number)
109+ unset DEPLOY ; if [[ $REF_TAG =~ ^[vV]?[0-9].* ]]; then DEPLOY='true' ; fi
110+ echo set-output name=DEPLOY::${DEPLOY:-<empty>/false}
111+ echo ::set-output name=DEPLOY::${DEPLOY}
112+ # DPKG architecture?
113+ unset DPKG_ARCH ; case ${{ matrix.job.target }} in i686-*-linux-*) DPKG_ARCH=i686 ;; x86_64-*-linux-*) DPKG_ARCH=amd64 ;; esac;
114+ echo set-output name=DPKG_ARCH::${DPKG_ARCH}
115+ echo ::set-output name=DPKG_ARCH::${DPKG_ARCH}
116+ # DPKG version?
117+ unset DPKG_VERSION ; if [[ $REF_TAG =~ ^[vV]?[0-9].* ]]; then DPKG_VERSION=${REF_TAG/#[vV]/} ; fi
118+ echo set-output name=DPKG_VERSION::${DPKG_VERSION}
119+ echo ::set-output name=DPKG_VERSION::${DPKG_VERSION}
120+ # DPKG base name/conflicts?
121+ DPKG_BASENAME=${PROJECT_NAME}
122+ DPKG_CONFLICTS=${PROJECT_NAME}-musl
123+ case ${{ matrix.job.target }} in *-musl) DPKG_BASENAME=${PROJECT_NAME}-musl ; DPKG_CONFLICTS=${PROJECT_NAME} ;; esac;
124+ echo set-output name=DPKG_BASENAME::${DPKG_BASENAME}
125+ echo set-output name=DPKG_CONFLICTS::${DPKG_CONFLICTS}
126+ echo ::set-output name=DPKG_BASENAME::${DPKG_BASENAME}
127+ echo ::set-output name=DPKG_CONFLICTS::${DPKG_CONFLICTS}
128+ # DPKG name
129+ unset DPKG_NAME;
130+ if [[ -n $DPKG_ARCH && -n $DPKG_VERSION ]]; then DPKG_NAME="${DPKG_BASENAME}_${DPKG_VERSION}_${DPKG_ARCH}.deb" ; fi
131+ echo set-output name=DPKG_NAME::${DPKG_NAME}
132+ echo ::set-output name=DPKG_NAME::${DPKG_NAME}
133+ # target-specific options
134+ # * CARGO_USE_CROSS (truthy)
135+ CARGO_USE_CROSS='true' ; case '${{ matrix.job.use-cross }}' in ''|0|f|false|n|no) unset CARGO_USE_CROSS ;; esac;
136+ echo set-output name=CARGO_USE_CROSS::${CARGO_USE_CROSS:-<empty>/false}
137+ echo ::set-output name=CARGO_USE_CROSS::${CARGO_USE_CROSS}
138+ # # * `arm` cannot be tested on ubuntu-* hosts (b/c testing is currently primarily done via comparison of target outputs with built-in outputs and the `arm` target is not executable on the host)
139+ JOB_DO_TESTING="true"
140+ case ${{ matrix.job.target }} in arm-*) unset JOB_DO_TESTING ;; esac;
141+ echo set-output name=JOB_DO_TESTING::${JOB_DO_TESTING:-<empty>/false}
142+ echo ::set-output name=JOB_DO_TESTING::${JOB_DO_TESTING}
143+ # # * test only library units tests and binary for arm-type targets
144+ unset CARGO_TEST_OPTIONS
145+ unset CARGO_TEST_OPTIONS ; case ${{ matrix.job.target }} in arm-* | aarch64-*) CARGO_TEST_OPTIONS="--lib --bin ${PROJECT_NAME}" ;; esac;
146+ echo set-output name=CARGO_TEST_OPTIONS::${CARGO_TEST_OPTIONS}
147+ echo ::set-output name=CARGO_TEST_OPTIONS::${CARGO_TEST_OPTIONS}
148+ # * executable for `strip`?
149+ STRIP="strip" ; case ${{ matrix.job.target }} in arm-unknown-linux-gnueabihf) STRIP="arm-linux-gnueabihf-strip" ;; aarch64-unknown-linux-gnu) STRIP="aarch64-linux-gnu-strip" ;; *-pc-windows-msvc) STRIP="" ;; esac;
150+ echo set-output name=STRIP::${STRIP}
151+ echo ::set-output name=STRIP::${STRIP}
152+ - name: Create all needed build/work directories
153+ shell: bash
154+ run: |
155+ mkdir -p '${{ steps.vars.outputs.STAGING }}'
156+ mkdir -p '${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_BASENAME }}'
157+ mkdir -p '${{ steps.vars.outputs.STAGING }}/dpkg'
158+ - name: rust toolchain ~ install
159+ uses: actions-rs/toolchain@v1
160+ with:
161+ toolchain: ${{ steps.vars.outputs.TOOLCHAIN }}
162+ target: ${{ matrix.job.target }}
163+ override: true
164+ profile: minimal # minimal component installation (ie, no documentation)
165+ - name: Info
166+ shell: bash
167+ run: |
168+ gcc --version || true
169+ rustup -V
170+ rustup toolchain list
171+ rustup default
172+ cargo -V
173+ rustc -V
174+ - name: Build
175+ uses: actions-rs/cargo@v1
176+ with:
177+ use-cross: ${{ steps.vars.outputs.CARGO_USE_CROSS }}
178+ command: build
179+ args: --release --target=${{ matrix.job.target }} ${{ matrix.job.cargo-options }}
180+ - name: Test
181+ uses: actions-rs/cargo@v1
182+ with:
183+ use-cross: ${{ steps.vars.outputs.CARGO_USE_CROSS }}
184+ command: test
185+ args: --target=${{ matrix.job.target }} ${{ steps.vars.outputs.CARGO_TEST_OPTIONS}} ${{ matrix.job.cargo-options }}
186+ - name: Archive executable artifacts
187+ uses: actions/upload-artifact@master
188+ with:
189+ name: ${{ env.PROJECT_NAME }}-${{ matrix.job.target }}
190+ path: target/${{ matrix.job.target }}/release/${{ env.PROJECT_NAME }}${{ steps.vars.outputs.EXE_suffix }}
191+ - name: Package
192+ shell: bash
193+ run: |
194+ # binary
195+ cp 'target/${{ matrix.job.target }}/release/${{ env.PROJECT_NAME }}${{ steps.vars.outputs.EXE_suffix }}' '${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_BASENAME }}/'
196+ # `strip` binary (if needed)
197+ if [ -n "${{ steps.vars.outputs.STRIP }}" ]; then "${{ steps.vars.outputs.STRIP }}" '${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_BASENAME }}/${{ env.PROJECT_NAME }}${{ steps.vars.outputs.EXE_suffix }}' ; fi
198+ # README and LICENSE
199+ # * spell-checker:ignore EADME ICENSE
200+ (shopt -s nullglob; for f in [R]"EADME"{,.*}; do cp $f '${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_BASENAME }}/' ; done)
201+ (shopt -s nullglob; for f in [L]"ICENSE"{-*,}{,.*}; do cp $f '${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_BASENAME }}/' ; done)
202+ # base compressed package
203+ pushd '${{ steps.vars.outputs.STAGING }}/' >/dev/null
204+ case ${{ matrix.job.target }} in
205+ *-pc-windows-*) 7z -y a '${{ steps.vars.outputs.PKG_NAME }}' '${{ steps.vars.outputs.PKG_BASENAME }}'/* | tail -2 ;;
206+ *) tar czf '${{ steps.vars.outputs.PKG_NAME }}' '${{ steps.vars.outputs.PKG_BASENAME }}'/* ;;
207+ esac;
208+ popd >/dev/null
209+ # dpkg
210+ if [ -n "${{ steps.vars.outputs.DPKG_NAME }}" ]; then
211+ DPKG_DIR="${{ steps.vars.outputs.STAGING }}/dpkg"
212+ # binary
213+ install -Dm755 'target/${{ matrix.job.target }}/release/${{ env.PROJECT_NAME }}${{ steps.vars.outputs.EXE_suffix }}' "${DPKG_DIR}/usr/bin/${{ env.PROJECT_NAME }}${{ steps.vars.outputs.EXE_suffix }}"
214+ if [ -n "${{ steps.vars.outputs.STRIP }}" ]; then "${{ steps.vars.outputs.STRIP }}" "${DPKG_DIR}/usr/bin/${{ env.PROJECT_NAME }}${{ steps.vars.outputs.EXE_suffix }}" ; fi
215+ # README and LICENSE
216+ (shopt -s nullglob; for f in [R]"EADME"{,.*}; do install -Dm644 "$f" "${DPKG_DIR}/usr/share/doc/${{ env.PROJECT_NAME }}/$f" ; done)
217+ (shopt -s nullglob; for f in [L]"ICENSE"{-*,}{,.*}; do install -Dm644 "$f" "${DPKG_DIR}/usr/share/doc/${{ env.PROJECT_NAME }}/$f" ; done)
218+ # control file
219+ mkdir -p "${DPKG_DIR}/DEBIAN"
220+ printf "Package: ${{ steps.vars.outputs.DPKG_BASENAME }}\nVersion: ${{ steps.vars.outputs.DPKG_VERSION }}\nSection: utils\nPriority: optional\nMaintainer: ${{ env.PROJECT_AUTH }}\nArchitecture: ${{ steps.vars.outputs.DPKG_ARCH }}\nProvides: ${{ env.PROJECT_NAME }}\nConflicts: ${{ steps.vars.outputs.DPKG_CONFLICTS }}\nDescription: ${{ env.PROJECT_DESC }}\n" > "${DPKG_DIR}/DEBIAN/control"
221+ # build dpkg
222+ fakeroot dpkg-deb --build "${DPKG_DIR}" "${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.DPKG_NAME }}"
223+ fi
224+ - name: Publish
225+ uses: softprops/action-gh-release@v1
226+ if: steps.vars.outputs.DEPLOY
227+ with:
228+ files: |
229+ ${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_NAME }}
230+ ${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.DPKG_NAME }}
231+ env:
232+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
233+
234+ coverage:
235+ name: Code Coverage
236+ runs-on: ${{ matrix.job.os }}
237+ strategy:
238+ fail-fast: true
239+ matrix:
240+ # job: [ { os: ubuntu-latest }, { os: macos-latest }, { os: windows-latest } ]
241+ job:
242+ - { os: ubuntu-latest , toolchain: nightly-2020-04-29 }
243+ - { os: macos-latest , toolchain: nightly-2020-04-29 }
244+ - { os: windows-latest , toolchain: nightly-2020-04-29-x86_64-pc-windows-gnu }
245+ steps:
246+ - uses: actions/checkout@v1
247+ - name: Initialize workflow variables
248+ id: vars
249+ shell: bash
250+ run: |
251+ # toolchain
252+ TOOLCHAIN="nightly" ## default to "nightly" toolchain
253+ # * use requested TOOLCHAIN if specified
254+ if [ -n "${{ matrix.job.toolchain }}" ]; then TOOLCHAIN="${{ matrix.job.toolchain }}" ; fi
255+ # * use requested TOOLCHAIN if specified
256+ if [ -n "${{ matrix.job.toolchain }}" ]; then TOOLCHAIN="${{ matrix.job.toolchain }}" ; fi
257+ echo set-output name=TOOLCHAIN::${TOOLCHAIN}
258+ echo ::set-output name=TOOLCHAIN::${TOOLCHAIN}
259+ # target-specific options
260+ # * CODECOV_FLAGS
261+ CODECOV_FLAGS=$( echo "${{ matrix.job.os }}" | sed 's/[^[:alnum:]]/_/g' )
262+ echo set-output name=CODECOV_FLAGS::${CODECOV_FLAGS}
263+ echo ::set-output name=CODECOV_FLAGS::${CODECOV_FLAGS}
264+ - name: rust toolchain ~ install
265+ uses: actions-rs/toolchain@v1
266+ with:
267+ toolchain: ${{ steps.vars.outputs.TOOLCHAIN }}
268+ override: true
269+ profile: minimal # minimal component installation (ie, no documentation)
270+ - name: Test
271+ uses: actions-rs/cargo@v1
272+ with:
273+ command: test
274+ args: --no-fail-fast
275+ env:
276+ CARGO_INCREMENTAL: '0'
277+ RUSTFLAGS: '-Zprofile -Ccodegen-units=1 -Cinline-threshold=0 -Clink-dead-code -Coverflow-checks=off -Zno-landing-pads'
278+ - name: Generate coverage data
279+ id: coverage
280+ uses: actions-rs/grcov@v0.1
281+ - name: Upload coverage results (to Codecov.io)
282+ uses: codecov/codecov-action@v1
283+ with:
284+ file: ${{ steps.coverage.outputs.report }}
285+ flags: ${{ steps.vars.outputs.CODECOV_FLAGS }}
286+ name: codecov-umbrella
287+ fail_ci_if_error: false