Tracking PR for v0.5.0 release

.github/ISSUE_TEMPLATE/1-bugreport.yml

@@ -0,0 +1,38 @@
+name: "Bug Report"
+description: "File a bug report"
+type: "Bug"
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for taking the time to fill out this bug report!
+  - type: textarea
+    id: version
+    attributes:
+      label: "Packages versions"
+      description: "Let us know the versions of any other packages used. For example, which version of AirScript are you using?"
+      placeholder: "air-script: 0.1.0"
+    validations:
+      required: true
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: "Bug description"
+      description: "Describe the behavior you are experiencing."
+      placeholder: "Tell us what happened and what should have happened."
+    validations:
+      required: true
+  - type: textarea
+    id: reproduce-steps
+    attributes:
+      label: "How can this be reproduced?"
+      description: "If possible, describe how to replicate the unexpected behavior that you see."
+      placeholder: "Steps!"
+    validations:
+      required: false
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This is automatically formatted as code, no need for backticks.
+      render: shell

.github/ISSUE_TEMPLATE/2-feature-request.yml

@@ -0,0 +1,20 @@
+name: "Feature request"
+description: "Request new goodies"
+type: "Feature"
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for taking the time to fill a feature request!
+  - type: textarea
+    id: scenario-why
+    attributes:
+      label: "Feature description"
+    validations:
+      required: true
+  - type: textarea
+    id: scenario-how
+    attributes:
+      label: "Why is this feature needed?"
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/3-task.yml

@@ -0,0 +1,36 @@
+name: "Task"
+description: "Work item"
+type: "Task"
+body:
+  - type: markdown
+    attributes:
+      value: |
+        A task should be less than a week worth of work!
+  - type: textarea
+    id: task-what
+    attributes:
+      label: "What should be done?"
+      placeholder: "Add support for new constraint type"
+    validations:
+      required: true
+  - type: textarea
+    id: task-how
+    attributes:
+      label: "How should it be done?"
+      placeholder: "Implement the new constraint type in the parser and codegen"
+    validations:
+      required: true
+  - type: textarea
+    id: task-done
+    attributes:
+      label: "When is this task done?"
+      placeholder: "The task is done when the new constraint type is fully implemented and tested"
+    validations:
+      required: true
+  - type: textarea
+    id: task-related
+    attributes:
+      label: "Additional context"
+      description: "Add context to the tasks. E.g. other related tasks or relevant discussions on PRs/chats."
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: true

.github/pull_request_template.md

@@ -0,0 +1,11 @@
+## Describe your changes
+
+
+## Checklist before requesting a review
+- Repo forked and branch created from `next` according to naming convention.
+- Commit messages and codestyle follow [conventions](./CONTRIBUTING.md).
+- Commits are [signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits).
+- Relevant issues are linked in the PR description.
+- Tests added for new functionality.
+- Documentation/comments updated according to changes.
+- Updated `CHANGELOG.md`

.github/workflows/book.yml

@@ -36,17 +36,20 @@ jobs:
     name: Build documentation
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@main
 
       # Installation from source takes a fair while, so we install the binaries directly instead.
       - name: Install mdbook and plugins
         uses: taiki-e/install-action@v2
         with:
-          tool: mdbook, mdbook-linkcheck, mdbook-alerts, mdbook-katex, mdbook-mermaid
+          tool: mdbook@0.4.48, mdbook-linkcheck, mdbook-alerts, mdbook-katex, mdbook-mermaid
 
       - name: Build book
         run: mdbook build docs/
 
+      - name: Test documentation examples
+        run: make test-docs
+
       # Only Upload documentation if we want to deploy (i.e. push to next).
       - name: Setup Pages
         if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/next' }}
@@ -58,7 +61,7 @@ jobs:
         uses: actions/upload-pages-artifact@v3
         with:
           # We specify multiple [output] sections in our book.toml which causes mdbook to create separate folders for each. This moves the generated `html` into its own `html` subdirectory.
-          path: ./docs/book/html
+          path: ./docs/target/book/html
 
   # Deployment job only runs on push to next.
   deploy:

.github/workflows/build.yml

@@ -0,0 +1,33 @@
+# Runs build related jobs.
+
+name: build
+
+# 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
+
+on:
+    push:
+        branches: [main, next]
+    pull_request:
+        types: [opened, reopened, synchronize]
+
+permissions:
+    contents: read
+
+jobs:
+  check:
+    name: check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@main
+      - uses: Swatinem/rust-cache@v2
+        with:
+          # Only update the cache on push onto the next branch. This strikes a nice balance between
+          # cache hits and cache evictions (github has a 10GB cache limit).
+          save-if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/next' }}
+      - name: Install rust
+        run: rustup update --no-self-update 
+      - name: Run check
+        run: make check

.github/workflows/changelog.yml

@@ -0,0 +1,26 @@
+# Runs changelog related jobs.
+# CI job heavily inspired by: https://github.com/tarides/changelog-check-action
+
+name: changelog
+
+on:
+  pull_request:
+    types: [opened, reopened, synchronize, labeled, unlabeled]
+
+permissions:
+  contents: read
+
+jobs:
+  changelog:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@main
+        with:
+          fetch-depth: 0
+      - name: Check for changes in changelog
+        env:
+          BASE_REF: ${{ github.event.pull_request.base.ref }}
+          NO_CHANGELOG_LABEL: ${{ contains(github.event.pull_request.labels.*.name, 'no changelog') }}
+        run: ./scripts/check-changelog.sh
+        shell: bash

.github/workflows/link-checker.yml

@@ -0,0 +1,56 @@
+name: Check documentation links
+
+on:
+  workflow_call:
+    inputs:
+      fail-fast:
+        required: false
+        default: true
+        type: boolean
+  schedule:
+    # runs once a day at 01:00 UTC
+    - cron: "0 1 * * *"
+
+permissions:
+  contents: read
+  issues: write
+
+jobs:
+  linkChecker:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set fail-fast flag depending on trigger
+        id: flags
+        run: |
+          if [ "${{ github.event_name }}" = "schedule" ]; then
+            echo "fail_fast=false" >> $GITHUB_OUTPUT
+          else
+            echo "fail_fast=${{ inputs.fail-fast }}" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Link Checker
+        id: lychee
+        uses: lycheeverse/[email protected]
+        with:
+          fail: ${{ steps.flags.outputs.fail_fast }}
+          args: |
+            --verbose
+            --exclude-mail
+            --exclude "localhost"
+            --exclude "127.0.0.1"
+            --exclude "^file://"
+            --exclude "github.com/0xMiden/.*"
+            docs/src/**/*.md
+            **/*.md
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Open issue on failure (only if fail-fast is false)
+        if: steps.lychee.outcome == 'failure' && steps.flags.outputs.fail_fast != 'true'
+        uses: peter-evans/create-issue-from-file@v5
+        with:
+          title: Link Checker Report
+          content-filepath: ./lychee/out.md
+          labels: report, automated issue

.github/workflows/lint.yml

@@ -0,0 +1,65 @@
+# Runs linting related jobs.
+
+name: lint
+
+# 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
+
+on:
+  push:
+    branches: [main, next]
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+permissions:
+  contents: read
+
+jobs:
+  clippy:
+    name: clippy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@main
+      - uses: Swatinem/rust-cache@v2
+        with:
+          # Only update the cache on push onto the next branch. This strikes a nice balance between
+          # cache hits and cache evictions (github has a 10GB cache limit). 
+          save-if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/next' }}
+      - name: Clippy
+        run: |
+          rustup update --no-self-update
+          rustup component add --toolchain stable clippy
+          make clippy
+
+  rustfmt:
+    name: rustfmt
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@main
+      - uses: Swatinem/rust-cache@v2
+        with:
+          # Only update the cache on push onto the next branch. This strikes a nice balance between
+          # cache hits and cache evictions (github has a 10GB cache limit). 
+          save-if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/next' }}
+      - name: Rustfmt
+        run: |
+          rustup update --no-self-update nightly
+          rustup +nightly component add rustfmt
+          make format-check
+
+  doc:
+    name: doc
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@main
+      - uses: Swatinem/rust-cache@v2
+        with:
+          # Only update the cache on push onto the next branch. This strikes a nice balance between
+          # cache hits and cache evictions (github has a 10GB cache limit). 
+          save-if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/next' }}
+      - name: Build docs
+        run: |
+          rustup update --no-self-update
+          make doc