reusable flows and tools setup

.cargo/config.toml

@@ -0,0 +1,3 @@
+# TODO(template) check if needed
+[target.wasm32-unknown-unknown]
+rustflags = ['--cfg', 'getrandom_backend="wasm_js"']

.dockerignore

@@ -0,0 +1,32 @@
+# Include any files or directories that you don't want to be copied to your
+# container here (e.g., local build artifacts, temporary files, etc.).
+#
+# For more help, visit the .dockerignore file reference guide at
+# https://docs.docker.com/go/build-context-dockerignore/
+
+**/.DS_Store
+**/.classpath
+**/.dockerignore
+**/.env
+**/.git
+**/.gitignore
+**/.project
+**/.settings
+**/.toolstarget
+**/.vs
+**/.vscode
+**/*.*proj.user
+**/*.dbmdl
+**/*.jfm
+**/charts
+**/docker-compose*
+**/compose*
+**/Dockerfile*
+**/node_modules
+**/npm-debug.log
+**/secrets.dev.yaml
+**/values.dev.yaml
+./target
+/target
+LICENSE
+README.md

.github/workflows/book.yml

@@ -0,0 +1,28 @@
+name: book
+
+# TODO(template) enable GH pages Settings -> Pages -> Build and deployment -> Source Github Actions
+# Documentation should be built and tested on every pull-request, and additionally deployed on push onto next.
+on:
+  pull_request:
+    path: ['docs/**']
+  push:
+    branches: [next]
+    path: ['docs/**']
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Always build and test the mdbook documentation whenever the docs folder is changed.
+  #
+  # The documentation is uploaded as a github artifact IFF it is required for deployment i.e. on push into next.
+  book:
+    # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    uses: 0xMiden/.github/.github/workflows/book.yml@main

.github/workflows/build-docker.yml

@@ -0,0 +1,23 @@
+name: Docker Build Check
+
+on:
+  push:
+    branches: [main, next]
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+jobs:
+  docker-build:
+    permissions:
+      contents: read
+      id-token: write
+    uses: 0xMiden/.github/.github/workflows/build-docker.yml@main
+    with:
+      component: mybinary # TODO(template) update for the project
+      dockerfile_path: 'bin/mybinary/Dockerfile'
+      use_cache: false # TODO(template) or provide AWS configuration secrets to use cache
+    secrets:
+      gh_token: ${{ secrets.GITHUB_TOKEN }}
+      # aws_region: ${{ secrets.AWS_REGION }}
+      # aws_role: ${{ secrets.AWS_ROLE }}
+      # aws_cache_bucket: ${{ secrets.AWS_CACHE_BUCKET }}

.github/workflows/changelog.yml

@@ -0,0 +1,9 @@
+name: changelog
+
+on:
+  pull_request:
+    types: [opened, reopened, synchronize, labeled, unlabeled]
+
+jobs:
+  changelog:
+    uses: 0xMiden/.github/.github/workflows/changelog.yml@main

.github/workflows/lint.yml

@@ -0,0 +1,17 @@
+name: lint
+
+on:
+  push:
+    branches: [main, next]
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+
+# Limits workflow concurrency to only the latest commit in the PR.
+concurrency:
+  group: "${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}"
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    uses: 0xMiden/.github/.github/workflows/lint.yml@main

.github/workflows/publish-debian.yml

@@ -0,0 +1,47 @@
+name: Publish Debian Package
+
+on:
+  workflow_dispatch:
+    inputs:
+      service:
+        description: "Name of service to publish"
+        required: true
+        type: choice
+        options:
+          - miden-mybinary # TODO(template) update for the project
+      crate_dir:
+        required: true
+        description: "Name of crate directory"
+        type: choice
+        options:
+          - mybinary # TODO(template) update for the project
+      package:
+        required: true
+        description: "Name of packaging directory"
+        type: choice
+        options:
+          - mybinary # TODO(template) update for the project
+      crate:
+        description: "Name of the binary crate to publish"
+        required: true
+        type: choice
+        options:
+          - miden-mybinary # TODO(template) update for the project
+      version:
+        description: "Version to release (E.G. v0.10.0-rc.1, v0.10.0). Corresponding git tag must already exist."
+        required: true
+        type: string
+
+jobs:
+  publish:
+    permissions:
+      id-token: write
+      contents: write
+    uses: 0xMiden/.github/.github/workflows/publish-debian.yml@main
+    with:
+      gh_token: ${{ secrets.GITHUB_TOKEN }}
+      gitref: ${{ inputs.version }}
+      crate_dir: ${{ inputs.crate_dir }}
+      service: ${{ inputs.service }}
+      package: ${{ inputs.package }}
+      crate: ${{ inputs.crate }}

.github/workflows/publish-docker.yml

@@ -0,0 +1,35 @@
+name: Publish Docker Image
+
+on:
+  release:
+    types: [prereleased, released]
+
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Version to release (E.G. v0.10.0-rc.1, v0.10.0). Corresponding git tag must already exist."
+        required: true
+        type: string
+
+env:
+  version: ${{ inputs.version || github.ref_name }}
+
+
+jobs:
+  publish:
+    permissions:
+      id-token: write
+      contents: write
+      packages: write
+      attestations: write
+    uses: 0xMiden/.github/.github/workflows/publish-docker.yml@main
+    with:
+      component: mybinary # TODO(template) update for the project
+      version: ${{ env.version }}
+    secrets:
+      gh_token: ${{ secrets.GITHUB_TOKEN }}
+      aws_region: ${{ secrets.AWS_REGION }}
+      aws_role: ${{ secrets.AWS_ROLE }}
+      aws_cache_bucket: ${{ secrets.AWS_CACHE_BUCKET }}
+
+

.github/workflows/release-plz-dry-run.yml

@@ -0,0 +1,14 @@
+name: Release-plz (dry-run)
+
+on:
+  push:
+    branches: [main, next]
+
+jobs:
+  release-plz-dry-run-release:
+    permissions:
+      contents: read
+    uses: 0xMiden/.github/.github/workflows/release-plz-dry-run.yml@main
+    secrets:
+      gh_token: ${{ secrets.GITHUB_TOKEN }}
+      cargo_registry_token: "test-dry-run"

.github/workflows/release-plz.yml

@@ -0,0 +1,14 @@
+name: Release-plz (main)
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  release-plz-release:
+    permissions:
+      contents: read
+    uses: 0xMiden/.github/.github/workflows/release-plz.yml@main
+    secrets:
+      gh_token: ${{ secrets.GITHUB_TOKEN }}
+      cargo_registry_token: ${{ secrets.CARGO_REGISTRY_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,16 @@
+name: test
+
+on:
+  push:
+    branches: [main, next]
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+# Limits workflow concurrency to only the latest commit in the PR.
+concurrency:
+  group: "${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}"
+  cancel-in-progress: true
+
+jobs:
+  test:
+    uses: 0xMiden/.github/.github/workflows/test.yml@main

.gitignore

@@ -21,4 +21,8 @@ env/
 *.out
 node_modules/
 *DS_Store
-*.iml
+*.iml
+book/
+
+# TODO(template) uncomment if not a binary
+# Cargo.lock

CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## v0.2.0 (TODO(template) add date)
+
+### Enhancements
+
+### Changes
+
+### Fixes
+
+## 0.1.0 (TODO(template) add date)
+
+- Initial release.