Merge [email protected] to main

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,72 @@
+name: Bug Report
+description: File a bug/issue
+title: "bug: "
+labels: ["bug", "status: needs triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        **Before** reporting an issue, make sure to read the [documentation](https://github.com/NVIDIA/NeMo-Guardrails/tree/develop/docs)
+        and search [existing issues](https://github.com/NVIDIA/NeMo-Guardrails/issues).
+
+        Usage questions such as ***"How do I...?"*** belong in [Discussions](https://github.com/NVIDIA/NeMo-Guardrails/discussions) and will be closed.
+
+        Thanks for taking the time to fill out this bug report!
+  - type: checkboxes
+    attributes:
+      label: Did you check docs and existing issues?
+      description: Make sure you checked all of the below before submitting an issue
+      options:
+        - label: I have read all the NeMo-Guardrails docs
+          required: true
+        - label: I have updated the package to the latest version before submitting this issue
+          required: true
+        - label: (optional) I have used the develop branch
+          required: false
+        - label: I have searched the existing issues of NeMo-Guardrails
+          required: true
+  - type: input
+    attributes:
+      label: "Python version (python --version)"
+      placeholder: Python 3.10.13
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: "Operating system/version"
+      placeholder: "MacOS 11.5"
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: "NeMo-Guardrails version (if you must use a specific version and not the latest"
+      placeholder: 0.10.0
+  - type: textarea
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is. Please include any related errors you see in logs. If you are using server or chat CLI run it in verbose mode.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Steps To Reproduce
+      description: Steps to reproduce the behavior.
+      placeholder: |
+        1.
+        2.
+        3.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: A concise description of what you expected to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Actual Behavior
+      description: A concise description of what you expected to happen.
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Ask a question
+    url: https://github.com/NVIDIA/NeMo-Guardrails/discussions
+    about: Use Github discussions instead

.github/ISSUE_TEMPLATE/documentation.yml

@@ -0,0 +1,49 @@
+name: "Documentation Issue"
+labels: ["documentation", "status: needs triage"]
+title: "doc: "
+description: "Did you find any errors, omissions, or unclear sections in the documentation?"
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for taking the time to file a complete bug report.
+
+        Before submitting your issue, please review the [relevant section](https://github.com/NVIDIA/NeMo-Guardrails/tree/develop/CONTRIBUTING.md#suggesting-enhancements-and-new-features) of our documentation.
+
+  - type: checkboxes
+    attributes:
+      label: Please also confirm the following
+      options:
+        - label: I have searched the [main issue tracker](https://github.com/NVIDIA/NeMo-Guardrails/issues) of NeMo Guardrails repository and believe that this is not a duplicate
+          required: true
+  - type: dropdown
+    attributes:
+      label: Issue Kind
+      description: |
+        What best describes the issue?
+      options:
+        - "Improving documentation"
+        - "Error in existing documentation"
+        - "Missing documentation"
+        - "Unclear documentation"
+        - "Other concerns with documentation"
+    validations:
+      required: true
+
+  - type: input
+    attributes:
+      label: Existing Link
+      description: |
+        If the documentation in question exists, please provide a link to it.
+      placeholder: "https://github.com/NVIDIA/NeMo-Guardrails/blob/develop/docs/"
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Description
+      description: |
+        Please provide a detailed description of the feature, including any relevant information. You can use markdown syntax.
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,36 @@
+name: Feature Request
+description: Suggest a new feature
+title: "feature: "
+labels: ["enhancement", "status: needs triage"]
+body:
+  - type: checkboxes
+    attributes:
+      label: Did you check the docs?
+      description: Make sure you read all the docs before submitting a feature request
+      options:
+        - label: I have read all the NeMo-Guardrails docs
+          required: true
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Is your feature request related to a problem? Please describe.
+      description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Describe the solution you'd like
+      description: A clear and concise description of what you want to happen.
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Describe alternatives you've considered
+      description: A clear and concise description of any alternative solutions or features you've considered.
+  - type: textarea
+    validations:
+      required: false
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.

.github/PULL-REQUEST-TEMPLATE.md

@@ -0,0 +1,18 @@
+## Description
+
+<!-- Describe the big picture of your changes to communicate to the maintainers
+  why we should accept this pull request. -->
+
+## Related Issue(s)
+
+<!--
+  If this PR fixes any issues, please link to the issue here.
+  - Fixes #<issue_number>
+-->
+
+## Checklist
+
+- [ ] I've read the [CONTRIBUTING](https://github.com/NVIDIA/NeMo-Guardrails/blob/develop/CONTRIBUTING.md) guidelines.
+- [ ] I've updated the documentation if applicable.
+- [ ] I've added tests if applicable.
+- [ ] @mentions of the person or team responsible for reviewing proposed changes.

.github/scripts/build.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+# Exit immediately if a command exits with a non-zero status.
+set -e
+
+# Define variables for paths
+PACKAGE_DIR="nemoguardrails"
+CHAT_UI_SRC="chat-ui"
+EXAMPLES_SRC="examples"
+CHAT_UI_DST="$PACKAGE_DIR/chat-ui"
+EXAMPLES_DST="$PACKAGE_DIR/examples"
+
+# Copy the directories into the package directory
+cp -r "$CHAT_UI_SRC" "$CHAT_UI_DST"
+cp -r "$EXAMPLES_SRC" "$EXAMPLES_DST"
+
+# Build the wheel using Poetry
+poetry build
+
+# Remove the copied directories after building
+rm -rf "$CHAT_UI_DST"
+rm -rf "$EXAMPLES_DST"

.github/workflows/_test.yml

@@ -0,0 +1,81 @@
+name: Reusable Tests
+
+on:
+  workflow_call:
+    inputs:
+      os:
+        description: "Operating system name"
+        required: true
+        default: Ubuntu
+        type: string
+      image:
+        description: "Runner image"
+        required: true
+        default: ubuntu-latest
+        type: string
+      python-version:
+        description: "Python version to test against"
+        required: true
+        default: "3.10"
+        type: string
+
+defaults:
+  run:
+    shell: bash
+env:
+  POETRY_VERSION: 1.8.2
+
+jobs:
+  tests:
+    name: ${{ inputs.os }} / Python ${{ inputs.python-version }}
+    runs-on: ${{ inputs.image }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ inputs.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ inputs.python-version }}
+
+      - name: Get full Python version
+        id: full-python-version
+        run: echo "version=$(python -c "import sys; print('-'.join(str(v) for v in sys.version_info))")" >> $GITHUB_OUTPUT
+
+      - name: Bootstrap poetry (Linux and macOS)
+        run: |
+          curl -sSL https://install.python-poetry.org | POETRY_VERSION=${{ env.POETRY_VERSION }} python -
+
+      - name: Update PATH (Linux and macOS)
+        if: runner.os != 'Windows'
+        run: echo "$HOME/.local/bin" >> $GITHUB_PATH
+
+      - name: Update PATH for Windows
+        if: runner.os == 'Windows'
+        run: echo "$APPDATA\\Python\\Scripts" >> $GITHUB_PATH
+
+      - name: Configure poetry
+        run: poetry config virtualenvs.in-project true
+
+      - name: Set up cache
+        uses: actions/cache@v4
+        id: cache
+        with:
+          path: .venv
+          key: venv-${{ runner.os }}-${{ steps.full-python-version.outputs.version }}-${{ hashFiles('**/poetry.lock') }}
+
+      - name: Ensure cache is healthy
+        if: steps.cache.outputs.cache-hit == 'true'
+        run: timeout 10s poetry run pip --version || rm -rf .venv
+
+      - name: Check Poetry .lock
+        run: poetry check --lock
+
+      - name: Install dependencies
+        run: poetry install --with dev
+
+      - name: Run pre-commit hooks
+        run: poetry run make pre_commit
+
+      - name: Run pytest
+        run: poetry run pytest -v