Version 0.X.X¶

0.2.0¶

🎉 New feature¶

Dockerize the project. (PR#186)

🔨 Breaking changes¶

Doesn't support Python version 3.8 anymore. (PR#202)

🪲 Bug Fix¶

🙋‍♂️ For production¶

💣 Critical bugs:
For the composite action of customized action, it should always git checkout the source code from the specific source repo. (PR#212)

👨‍💻 For development¶

Update the property classify setting about missing Python version 3.13. (PR#207)
Fix the incorrect regex to match the specific file paths for documentation part. PR#218
Fix the Poetry configuration for the GitHub dependency bot. (PR#223)

♻️ Refactor¶

Reuse the common function which has been implemented in the library Fake-API-Server for clear code. (PR#187)
Reuse the new CI workflow about checking deployment state. (PR#338)

🍀 Improvement¶

Add setting default value about the current GitHub repository if property git-info.repo is empty. (PR#147)
Adjust the default PR body values to be more clear and readable for PR reviewers. (PR#154)
Adjust the PR template setting to be more friendly.
Import to use configuration CODEOWNERS to manage the owners of source code and remove the deprecated field in GitHub dependency bot. ([PR#377])

📑 Docs¶

Update the content for new changes about the default PR body value. (PR#181)
Let the example code and example result to be more clear. (PR#217)
Add a new section about development details of this project. (PR#219)
Activate the feature about overriding for the documentation UI/UX. (PR#221)
Adjust the note title to be more readable. (PR#222)

🤖 Upgrade dependencies¶

Upgrade the Python dependencies.
Bump cryptography from 43.0.3 to 44.0.1 (PR#201)
Bump jinja2 from 3.1.4 to 3.1.6 (PR#229)
Bump mkdocs-autorefs from 1.2.0 to 1.4.1 (PR#238)
Bump mkdocs-material from 9.6.3 to 9.6.12 (PR#241)
Bump mkdocs-git-revision-date-localized-plugin from 1.3.0 to 1.4.5 (PR#241)
Bump coverage from 6.5.0 to 7.8.0 (PR#247)
Bump pre-commit from 3.5.0 to 4.2.0 (PR#250)
Bump mkdocstrings from 0.26.1 to 0.29.1 (PR#281)
Bump pylint from 3.2.7 to 3.3.6 (PR#282)
Bump pytest-rerunfailures from 14.0 to 15.0 (PR#283)
Bump pytest from 8.3.4 to 8.3.5 (PR#286)
Bump mkdocstrings-python from 1.11.1 to 1.13.0 (PR#287)
Bump pytest-cov from 5.0.0 to 6.1.1 (PR#325)
Bump pylint from 3.3.6 to 3.3.7 (PR#331)
Bump pytest-rerunfailures from 15.0 to 15.1 (PR#339)
Upgrade pre-commit dependencies. (PR#200, PR#330)
Upgrade the CI reusable workflows.
Bump Chisanan232/GitHub-Action_Reusable_Workflows-Python from 6.1 to 7.2 (PR#201)
Bump Chisanan232/GitHub-Action_Reusable_Workflows-Python from 7.2 to 7.3 (PR#334)

🚮Deprecate¶

Doesn't support Python version 3.8 anymore. (PR#202)

0.1.0¶

🎉 New feature¶

Newborn of PyFake-API-Server-Surveillance.
A Python library about monitoring specific API interface and keeping PyFake-API-Server config up-to-update.

A customized action for GitHub Action.

name: Monitor Back-End API interface

on:
  # In generally, it's reasonable that using schedule feature of GitHub Action to monitor the Back-End side API change..
  schedule:
    - cron: "15 4,5 * * *"   # <=== Change this value

permissions:
  contents: write  # Need this to push commits
  pull-requests: write  # Need this to open pull request

jobs:
  monitor-and-update:
    runs-on: ubuntu-latest
    steps:
      # Clone the fake-api-server config
      - name: Clone project
        uses: actions/checkout@v4

      # Monitor and update the config if it needs by opening pull request
      - name: Run Fake-API-Server-Surveillance
        uses: ./
        with:
          config-path: <your fake-api-server-surveillance config>
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

📑 Docs¶

Add documentation for this Python base CI tool.

🤖 Upgrade dependencies¶

Upgrade pre-commit dependencies.