Add possibility to attach files in release, fix #2

Author: h4sh3d

.github/workflows/create-release.yml

@@ -2,6 +2,15 @@ name: "Create release"
 
 on:
   workflow_call:
+    inputs:
+      artifact_name:
+        description: 'The name of the artifact to download. Default to no artifact downloaded.'
+        required: false
+        type: string
+      files:
+        description: 'Newline-delimited globs of paths to assets to upload for release, must be found in the downloaded artifact.'
+        required: false
+        type: string
 
 jobs:
   create_release:
@@ -26,15 +35,20 @@ jobs:
         with:
           version: ${{ steps.extract-version.outputs.version }}
 
+      - name: Download artifacts for release
+        if: ${{ inputs.artifact_name }}
+        uses: actions/download-artifact@v2
+        with:
+          name: ${{ inputs.artifact_name }}
+
       - name: Create GitHub release
-        uses: actions/create-release@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        uses: softprops/[email protected]
         with:
+          name: ${{ steps.extract-version.outputs.version }}
           tag_name: ${{ format('v{0}', steps.extract-version.outputs.version) }}
-          release_name: ${{ steps.extract-version.outputs.version }}
+          fail_on_unmatched_files: ${{ inputs.artifact_name }}
           draft: false
           prerelease: false
           body: ${{ steps.changelog.outputs.description }}
-          commitish: ${{ github.event.pull_request.merge_commit_sha }}
-
+          target_commitish: ${{ github.event.pull_request.merge_commit_sha }}
+          files: ${{ inputs.files }}

CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add workflow call inputs on `create-release.yml` workflow to pass an artifact containing files to attached to the release
+
+### Changed
+
+- Improved documentation on how to chain and trigger workflows
+
 ## [1.0.1] - 2021-10-29
 
 ### Fixed

README.md

@@ -58,9 +58,54 @@ jobs:
     uses: farcaster-project/workflows/.github/workflows/[email protected]
 ```
 
+If you want to attached files to the release you can declare a `create_release` job with:
+
+```yaml
+jobs:
+  produce_binaries:
+    name: Compile released binaries
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Compile released binaries
+        run: ...
+
+      - name: Archive release folder
+        uses: actions/upload-artifact@v2
+        with:
+          name: release-folder
+          path: target/release
+          retention-days: 7
+
+  create_release:
+    name: Create from merged release branch
+    if: github.event.pull_request.merged == true && startsWith(github.event.pull_request.head.ref, 'release/')
+    uses: farcaster-project/workflows/.github/workflows/[email protected]
+    needs: produce_binaries
+    with:
+      artifact_name: release-folder
+      files: |
+         target/release/bin1
+         target/release/bin2
+```
+
+You can add another job after `create_release`, e.g. `releast_to_crates`, triggered only when the first is successfully completed i.e. when the release is published with:
+
+```yaml
+  releast_to_crates:
+    name: Release to crates.io
+    uses: farcaster-project/workflows/.github/workflows/[email protected]
+    needs: create_release
+    secrets:
+      cratesio_token: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+```
+
+Or use the method below with `workflow_run: workflows: ["Name of the worflow"]` to keep separated files.
+
 ### Release to crates.io
 
-`release-to-crates-io.yml` publish the crate to crates.io under the authentified user by **cratesio_token**. Example of usage:
+`release-to-crates-io.yml` publish the crate to crates.io under the authentified user by **cratesio_token**. Example of stand-alone usage (see above for chained usage after `create_release`):
 
 ```yaml
 name: Release to crates.io
@@ -77,6 +122,19 @@ jobs:
       cratesio_token: ${{ secrets.CARGO_REGISTRY_TOKEN }}
 ```
 
+If you want to trigger this workflow after another you can add:
+
+```yaml
+# Trigger when the "Create release" workflow succeeded
+on:
+  workflow_run:
+    workflows: ["Create release"]
+    types:
+      - completed
+```
+
+Where `"Create release"` is the name of the workflow that will trigger the `"Release to crates.io"` workflow when completed.
+
 ## Changelog
 
 See [CHANGELOG.md](CHANGELOG.md) for detailed version logs.