Adding in build & release workflows (#4)

Adding in build & release workflows

Author: Proryanator

.github/workflows/pull_request.yml

@@ -0,0 +1,26 @@
+name: Pull Request Workflow
+
+on:
+  pull_request:
+
+
+# maybe we can share these permissions
+permissions:
+  contents: read
+  pull-requests: read
+
+jobs:
+  windows:
+    uses: ./.github/workflows/pull_request_workflow.yml
+    with:
+      platform: windows-2022
+
+  #linux:
+  #  uses: ./.github/workflows/pull_request_workflow.yml
+  #  with:
+  #    platform: ubuntu-20.04
+
+  #mac:
+  #  uses: ./.github/workflows/pull_request_workflow.yml
+  #  with:
+  #    platform: macos-12

.github/workflows/pull_request_workflow.yml

@@ -0,0 +1,37 @@
+on:
+  workflow_call:
+    inputs:
+      platform:
+        required: true
+        type: string
+
+permissions:
+  contents: read
+  pull-requests: read
+
+jobs:
+  setup-and-build:
+    uses: ./.github/workflows/setup-and-build.yml
+    with:
+      platform: ${{inputs.platform}}
+
+  unit-test:
+    runs-on: ${{inputs.platform}}
+    needs: setup-and-build
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Restore Rust Dependencies
+        uses: actions/cache/restore@v3
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{inputs.platform}}-${{github.sha}}
+
+      - name: Run Unit Tests
+        run: cargo test --no-fail-fast

.github/workflows/release.yml

@@ -0,0 +1,60 @@
+name: Release Workflow
+
+on:
+  workflow_call:
+    inputs:
+      platform:
+        required: true
+        type: string
+      artifacts:
+        required: true
+        type: string
+      # TODO: eventually we can auto-generate this
+      tag:
+        required: true
+        type: string
+      name:
+        required: true
+        type: string
+      body:
+        required: true
+        type: string
+
+jobs:
+  setup-and-build:
+    uses: ./.github/workflows/setup-and-build.yml
+    with:
+      platform: ${{inputs.platform}}
+
+  release:
+    runs-on: ${{inputs.platform}}
+    needs: setup-and-build
+    permissions:
+      contents: write
+    steps:
+      - name: Restore Rust Dependencies
+        uses: actions/cache/restore@v3
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{inputs.platform}}-${{github.sha}}
+
+      - name: Run Cargo Build
+        run:
+          cargo build --release
+
+      - name: Publish Release
+        uses: ncipollo/release-action@v1
+        with:
+          artifacts: ${{inputs.artifacts}}
+          name: ${{inputs.name}}
+          body: ${{inputs.body}}
+          tag: ${{inputs.tag}}
+          # will remove this once the tool is out of the alpha/pre-release stage
+          prerelease: true
+          # do we need this? Might want to review what's produced
+          draft: true

.github/workflows/setup-and-build.yml

@@ -0,0 +1,38 @@
+on:
+  workflow_call:
+    inputs:
+      platform:
+        required: true
+        type: string
+
+permissions:
+  contents: read
+  pull-requests: read
+
+jobs:
+  setup-and-build:
+    runs-on: ${{inputs.platform}}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Rust
+        uses: ATiltedTree/setup-rust@v1
+        with:
+          rust-version: 1.66.0
+
+      - name: Build
+        run:
+          cargo build
+
+      # from https://github.com/actions/cache/blob/main/examples.md#rust---cargo
+      - name: Cache Rust Dependencies
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{inputs.platform}}-${{github.sha}}

.github/workflows/windows_release.yml

@@ -0,0 +1,20 @@
+name: Windows Release Workflow
+
+on:
+  workflow_dispatch:
+    branches:
+      - main
+
+permissions:
+  # required for us to upload artifacts from the release
+  contents: write
+  pull-requests: read
+
+
+jobs:
+  windows-release:
+    uses: ./.github/workflows/release.yml
+    with:
+      # all other inputs will be done by hand
+      platform: windows-2022
+      artifacts: "target/release/benchmark.exe,target/release/permutor-cli.exe"

.gitignore

@@ -2,10 +2,6 @@
 # will have compiled files and executables
 target/
 
-# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
-# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
-Cargo.lock
-
 # These are backup files generated by rustfmt
 **/*.rs.bk