✨ feat: first commit :D

adriamontoto · Dec 21, 2024 · 1ff0c74 · 1ff0c74
commit 1ff0c74
Show file tree

Hide file tree

Showing 20 changed files with 889 additions and 0 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml
@@ -0,0 +1,44 @@
+name: 🐛 Bug Report
+description: Report a bug or unexpected behavior in ⚒️ Object Mother Pattern.
+labels: [bug, pending]
+
+body:
+  - type: markdown
+    attributes:
+      value: Thank you for interest! Please fill out the form below to report a bug. 💥
+
+  - type: textarea
+    id: description
+    validations:
+      required: true
+    attributes:
+      label: Description
+      description: |
+        Please explain what you are seeing and what you would expect to see.
+
+        Please provide as much detail as possible to make understanding and solving your problem as quick as possible. 🙏
+
+  - type: textarea
+    id: example
+    attributes:
+      label: Example Code
+      render: Python
+      description: >
+        If applicable, please add a self-contained,
+        [minimal, reproducible, example](https://stackoverflow.com/help/minimal-reproducible-example)
+        demonstrating the bug.
+
+      placeholder: |
+        import object_mother_pattern
+
+        ...
+
+  - type: textarea
+    id: version
+    validations:
+      required: true
+    attributes:
+      label: Python, Object Mother Pattern & OS Version
+      render: Text
+      description: |
+        Which version of Python & CObject Mother Pattern are you using, and which Operating System?
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml
@@ -0,0 +1,22 @@
+name: ✨ Feature Request
+description: Suggest a new feature for ⚒️ Object Mother Pattern.
+labels: [enhancement, pending]
+
+body:
+  - type: markdown
+    attributes:
+      value: Thank you for interest! Please fill out the form below to suggest a new feature. 🚀
+
+  - type: textarea
+    id: description
+    validations:
+      required: true
+    attributes:
+      label: Description
+      description: |
+        Please give as much detail as possible about the feature you would like to suggest. 🙏
+
+        You might like to add:
+        * A demo of how code might look when using the feature
+        * Your use case(s) for the feature
+        * Why the feature should be added to object mother pattern (as opposed to another library or just implemented in your code)
diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml
@@ -0,0 +1,16 @@
+version: 2
+
+updates:
+  - package-ecosystem: github-actions
+    directory: '/'
+    schedule:
+      interval: daily
+    commit-message:
+      prefix: '👷🏻 ci:'
+
+  - package-ecosystem: pip
+    directory: '/'
+    schedule:
+      interval: daily
+    commit-message:
+      prefix: '📦 build:'
diff --git a/.github/workflows/codeql.yaml b/.github/workflows/codeql.yaml
@@ -0,0 +1,40 @@
+name: Code Quality Pipeline
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+    types: [opened, synchronize]
+  schedule:
+    - cron: '0 0 * * 1' # Every Monday at 00:00 UTC
+
+permissions:
+  security-events: write
+
+jobs:
+  analyze:
+    name: Code Quality Pipeline - ${{ matrix.language }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        language: [python]
+        build-mode: [none]
+
+    steps:
+      - name: 📥 Checkout the repository
+        uses: actions/checkout@v4.2.2
+
+      - name: ▶️ CodeQL Initialization
+        uses: github/codeql-action/init@v3.27.9
+        with:
+          languages: ${{ matrix.language }}
+          build-mode: ${{ matrix.build-mode }}
+          queries: security-extended, security-and-quality
+
+      - name: 🔬 CodeQL Analysis
+        uses: github/codeql-action/analyze@v3.27.9
+        with:
+          category: '/language:${{matrix.language}}'
diff --git a/.github/workflows/coverage.yaml b/.github/workflows/coverage.yaml
@@ -0,0 +1,48 @@
+name: Smokeshow Pipeline
+
+on:
+  workflow_run:
+    workflows: [Test Pipeline]
+    types: [completed]
+
+permissions:
+  statuses: write
+
+jobs:
+  smokeshow:
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version: [3.13]
+
+    name: Smokeshow Pipeline
+    timeout-minutes: 5
+    steps:
+      - name: 🐍 Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5.3.0
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: 📦 Install dependencies
+        run: pip install smokeshow
+
+      - name: 📥 Download coverage files
+        uses: actions/download-artifact@v4.1.8
+        with:
+          name: coverage-html
+          path: htmlcov
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          run-id: ${{ github.event.workflow_run.id }}
+
+      - name: 📊 Upload coverage report
+        run: smokeshow upload htmlcov
+        env:
+          SMOKESHOW_GITHUB_STATUS_DESCRIPTION: Coverage {coverage-percentage}
+          SMOKESHOW_GITHUB_COVERAGE_THRESHOLD: 100
+          SMOKESHOW_GITHUB_CONTEXT: coverage
+          SMOKESHOW_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SMOKESHOW_GITHUB_PR_HEAD_SHA: ${{ github.event.workflow_run.head_sha }}
+          SMOKESHOW_AUTH_KEY: ${{ secrets.SMOKESHOW_AUTH_KEY }}
diff --git a/.github/workflows/format.yaml b/.github/workflows/format.yaml
@@ -0,0 +1,54 @@
+name: Format Pipeline
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+    types: [opened, synchronize]
+
+permissions:
+  contents: write
+
+jobs:
+  format:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version: [3.13]
+
+    name: Format Pipeline - Python ${{ matrix.python-version }} on ${{ matrix.os }}
+    timeout-minutes: 5
+    steps:
+      - name: 📥 Checkout the repository
+        uses: actions/checkout@v4.2.2
+
+      - name: 🐍 Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5.3.0
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - id: cache
+        name: 📦 Create cache
+        uses: actions/cache@v4.2.0
+        with:
+          path: ${{ env.pythonLocation }}
+          key: ${{ matrix.os }}-python-${{ matrix.python-version }}-${{ hashFiles('pyproject.toml', 'requirements*') }}
+          restore-keys: ${{ matrix.os }}-python-${{ matrix.python-version }}-
+
+      - name: 📦 Install dependencies
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: make install-dev
+
+      - name: 🏃 Run Formatter
+        run: make format
+
+      - name: 📤 Commit & Push Changes
+        uses: EndBug/add-and-commit@v9.1.4
+        with:
+          add: .
+          message: '🔨 refactor: run automatic formatter'
+          commit: --signoff
+          default_author: github_actions
diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
@@ -0,0 +1,50 @@
+name: Lint Pipeline
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+    types: [opened, synchronize]
+
+jobs:
+  lint:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version: [3.13]
+
+    name: Lint Pipeline - Python ${{ matrix.python-version }} on ${{ matrix.os }}
+    timeout-minutes: 10
+    steps:
+      - name: 📥 Checkout the repository
+        uses: actions/checkout@v4.2.2
+
+      - name: 🐍 Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5.3.0
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - id: cache
+        name: 📦 Create cache
+        uses: actions/cache@v4.2.0
+        with:
+          path: ${{ env.pythonLocation }}
+          key: ${{ matrix.os }}-python-${{ matrix.python-version }}-${{ hashFiles('pyproject.toml', 'requirements*') }}
+          restore-keys: ${{ matrix.os }}-python-${{ matrix.python-version }}-
+
+      - name: 📦 Install dependencies
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: make install-dev
+
+      - name: 🏃 Run Linter
+        run: make lint
+
+      - name: 🫙 Store type coverage
+        uses: actions/upload-artifact@v4.5.0
+        if: always()
+        with:
+          name: type_coverage_report_${{ matrix.os }}_${{ matrix.python-version }}
+          path: index.txt
diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml
@@ -0,0 +1,47 @@
+name: Publish Pipeline
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version: [3.13]
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/object-mother-pattern/
+
+    permissions:
+      id-token: write
+
+    name: Publish Pipeline
+    timeout-minutes: 5
+    steps:
+      - name: 📥 Checkout the repository
+        uses: actions/checkout@v4.2.2
+
+      - name: 🐍 Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5.3.0
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: 📦 Install dependencies
+        run: pip install build
+
+      - name: 🛠️ Build distribution
+        run: python -m build
+
+      - name: 🫙 Store distribution package
+        uses: actions/upload-artifact@v4.5.0
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: 🚀 Publish
+        uses: pypa/gh-action-pypi-publish@v1.12.3