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