Skip to content

Commit

Permalink
Add GitHub workflows for CI, release tarball, and Docker image
Browse files Browse the repository at this point in the history
This commit adds
- release action to release tarball for downloading
- run CI on pull request

Signed-off-by: bin liu <[email protected]>
  • Loading branch information
liubin authored and gnprice committed Dec 4, 2022
1 parent da7b78c commit b3fd78c
Show file tree
Hide file tree
Showing 4 changed files with 175 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: CI
on:
pull_request:
types:
- opened
- edited
- reopened
- synchronize

env:
CARGO_TERM_COLOR: always
RUST_TARGET: x86_64-unknown-linux-musl

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Build and test
uses: gmiam/rust-musl-action@master
with:
args: make all
118 changes: 118 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
name: release

on:
push:
tags:
- v[0-9]+.[0-9]+.[0-9]+*
workflow_dispatch:

env:
CARGO_TERM_COLOR: always
RUST_TARGET: x86_64-unknown-linux-musl
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}

jobs:
build-linux:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Build toml cli
# uses: juankaram/rust-musl-action@master
uses: gmiam/rust-musl-action@master
with:
args: cargo build --target $RUST_TARGET --release
- name: store-artifacts
uses: actions/upload-artifact@v2
with:
if-no-files-found: error
name: toml-artifacts-linux
path: |
target/${{ env.RUST_TARGET }}/release/toml
prepare-tarball-linux:
runs-on: ubuntu-latest
needs: [build-linux]
steps:
- name: download artifacts
uses: actions/download-artifact@v2
with:
name: toml-artifacts-linux
path: toml-cli
- name: prepare release tarball
run: |
tag=$(echo $GITHUB_REF | cut -d/ -f3-)
tarball="toml-cli-$tag-linux-amd64.tgz"
chmod +x toml-cli/*
tar cf - toml-cli | gzip > ${tarball}
echo "tarball=${tarball}" >> $GITHUB_ENV
shasum="$tarball.sha256sum"
sha256sum $tarball > $shasum
echo "tarball_shasum=${shasum}" >> $GITHUB_ENV
- name: store-artifacts
uses: actions/upload-artifact@v2
with:
name: release-tarball
path: |
${{ env.tarball }}
${{ env.tarball_shasum }}
create-release:
runs-on: ubuntu-latest
needs: [prepare-tarball-linux]
steps:
- name: download artifacts
uses: actions/download-artifact@v2
with:
name: release-tarball
path: tarballs
- name: prepare release env
run: |
echo "tarballs<<EOF" >> $GITHUB_ENV
for I in $(ls tarballs);do echo "tarballs/${I}" >> $GITHUB_ENV; done
echo "EOF" >> $GITHUB_ENV
tag=$(echo $GITHUB_REF | cut -d/ -f3-)
echo "tag=${tag}" >> $GITHUB_ENV
cat $GITHUB_ENV
- name: push release
if: github.event_name == 'push'
uses: softprops/action-gh-release@v1
with:
name: "Toml cli ${{ env.tag }}"
body: |
"Toml cli release ${{ env.tag }}"
generate_release_notes: true
files: |
${{ env.tarballs }}
publish-image:
runs-on: ubuntu-latest
needs: [build-linux]
steps:
- name: Checkout repository
uses: actions/checkout@v2
- name: Log in to the container registry
uses: docker/login-action@v2
with:
registry: ${{ env.REGISTRY }}
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: download artifacts
uses: actions/download-artifact@v2
with:
name: toml-artifacts-linux
path: misc
- name: Extract metadata (tags, labels) for Docker
id: meta
uses: docker/metadata-action@v4
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
- name: build and push toml cli image
uses: docker/build-push-action@v3
with:
context: misc
file: misc/Dockerfile
push: true
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
31 changes: 31 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
default: build

CARGO ?= $(shell which cargo)
RUST_TARGET ?= x86_64-unknown-linux-musl
INSTALL_DIR_PREFIX ?= "/usr/local/bin"

.format:
${CARGO} fmt -- --check

build: .format
${CARGO} build --target ${RUST_TARGET} --release
# Cargo will skip checking if it is already checked
${CARGO} clippy --bins --tests -- -Dwarnings

install: .format build
mkdir -m 755 -p $(INSTALL_DIR_PREFIX)
install -m 755 target/${RUST_TARGET}/release/toml $(INSTALL_DIR_PREFIX)/toml

clean:
${CARGO} clean

ut:
RUST_BACKTRACE=1 ${CARGO} test --workspace -- --skip integration --nocapture

integration:
# run tests under `test` directory
RUST_BACKTRACE=1 ${CARGO} test --workspace -- integration --nocapture

test: ut integration

all: build install test
4 changes: 4 additions & 0 deletions misc/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
FROM alpine:3.17

ADD toml /bin/toml
RUN chmod +x /bin/toml

0 comments on commit b3fd78c

Please sign in to comment.