Even nicer README

This commit is contained in:
Sven-Hendrik Haase 2019-08-23 04:32:00 +02:00 committed by GitHub
parent 344275d0b1
commit dbd8f0788d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

116
README.md
View File

@ -20,68 +20,72 @@ This is a common use case as you will want to upload release binaries for your t
Simple example: Simple example:
name: Publish ```yaml
name: Publish
on: on:
create: create:
tags: tags:
jobs: jobs:
build: build:
name: Publish binaries name: Publish binaries
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: hecrj/setup-rust-action@master - uses: hecrj/setup-rust-action@master
with: with:
rust-version: stable rust-version: stable
- uses: actions/checkout@v1 - uses: actions/checkout@v1
- name: Build - name: Build
run: cargo build --release run: cargo build --release
- name: Upload binaries to release - name: Upload binaries to release
uses: svenstaro/upload-release-action@v1-release uses: svenstaro/upload-release-action@v1-release
with: with:
repo_token: ${{ secrets.GITHUB_TOKEN }} repo_token: ${{ secrets.GITHUB_TOKEN }}
file: target/release/mything file: target/release/mything
asset_name: mything asset_name: mything
tag: {{ github.event.ref }} tag: {{ github.event.ref }}
overwrite: true overwrite: true
```
Complex example with more operating systems: Complex example with more operating systems:
name: Publish ```yaml
name: Publish
on: on:
create: create:
tags: tags:
jobs: jobs:
build: build:
name: Publish for ${{ matrix.os }} name: Publish for ${{ matrix.os }}
runs-on: ${{ matrix.os }} runs-on: ${{ matrix.os }}
strategy: strategy:
matrix: matrix:
include: include:
- os: ubuntu-latest - os: ubuntu-latest
artifact_name: mything artifact_name: mything
asset_name: mything-linux-amd64 asset_name: mything-linux-amd64
- os: windows-latest - os: windows-latest
artifact_name: mything.exe artifact_name: mything.exe
asset_name: mything-windows-amd64 asset_name: mything-windows-amd64
- os: macos-latest - os: macos-latest
artifact_name: mything artifact_name: mything
asset_name: mything-macos-amd64 asset_name: mything-macos-amd64
steps: steps:
- uses: hecrj/setup-rust-action@master - uses: hecrj/setup-rust-action@master
with: with:
rust-version: stable rust-version: stable
- uses: actions/checkout@v1 - uses: actions/checkout@v1
- name: Build - name: Build
run: cargo build --release run: cargo build --release
- name: Upload binaries to release - name: Upload binaries to release
uses: svenstaro/upload-release-action@v1-release uses: svenstaro/upload-release-action@v1-release
with: with:
repo_token: ${{ secrets.GITHUB_TOKEN }} repo_token: ${{ secrets.GITHUB_TOKEN }}
file: target/release/${{ matrix.artifact_name }} file: target/release/${{ matrix.artifact_name }}
asset_name: ${{ matrix.asset_name }} asset_name: ${{ matrix.asset_name }}
```