[CHORE] add changelog github action, edit example output's rich box

Author: bnbong

.github/changelog-ci-config.yaml

@@ -0,0 +1,42 @@
+changelog_type: 'commit_message' # or 'pull_request'
+header_prefix: 'Version:'
+commit_changelog: true
+comment_changelog: true
+include_unlabeled_changes: true
+unlabeled_group_title: 'Unlabeled Changes'
+pull_request_title_regex: '^Release'
+version_regex: 'v?([0-9]{1,2})+[.]+([0-9]{1,2})+[.]+([0-9]{1,2})\s\(\d{1,2}-\d{1,2}-\d{4}\)'
+exclude_labels:
+  - bot
+  - dependabot
+  - ci
+group_config:
+  - title: Bug Fixes
+    labels:
+      - bug
+      - bugfix
+      - FIX
+      - fix
+  - title: Code Improvements
+    labels:
+      - improvements
+      - enhancement
+      - ADD
+      - add
+  - title: New Features
+    labels:
+      - feature
+      - FEAT
+      - feat
+  - title: Documentation Updates
+    labels:
+      - docs
+      - documentation
+      - doc
+      - DOCS
+  - title: Template Updates
+    labels:
+      - template
+      - TEMPLATE
+      - TEMPLATES
+      - templates

.github/workflows/changelog.yml

@@ -0,0 +1,37 @@
+name: Changelog CI
+
+on:
+  pull_request:
+    types: [ opened ]
+
+  # Optionally you can use `workflow_dispatch` to run Changelog CI Manually
+  workflow_dispatch:
+    inputs:
+      release_version:
+        description: 'Set Release Version'
+        required: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checks-out your repository
+      - uses: actions/checkout@v2
+
+      - name: Run Changelog CI
+        uses: saadmk11/[email protected]
+        with:
+          # Optional, only required when you want more customization
+          # e.g: group your changelog by labels with custom titles,
+          # different version prefix, pull request title and version number regex etc.
+          # config file can be in JSON or YAML format.
+          config_file: changelog-ci-config.yaml
+          # Optional, only required when you want to run Changelog CI
+          # on an event other than `pull_request` event.
+          # In this example `release_version` is fetched from `workflow_dispatch` events input.
+          # You can use any other method to fetch the release version
+          # such as environment variable or from output of another action
+          release_version: ${{ github.event.inputs.release_version }}
+          # Optional
+          github_token: ${{ secrets.GITHUB_TOKEN }}

.yamllint

@@ -19,3 +19,4 @@ rules:
 ignore: |
   .github/dependabot.yml
   .github/release-drafter.yml
+  .github/changelog-ci-config.yaml

README.md

@@ -0,0 +1 @@
+{!CHANGELOG.md!}

docs/changelog.md

@@ -56,8 +56,7 @@ Enter the author name: John Doe
 Enter the author email: [email protected]
 Enter the project description: My awesome FastAPI project
 
-
-             Project Information
+           Project Information
 ┌──────────────┬────────────────────────────┐
 │ Project Name │ my-awesome-project         │
 │ Author       │ John Doe                   │
@@ -74,7 +73,6 @@ Available Stacks and Dependencies:
 │ Dependency 4 │ pydantic-settings │
 └──────────────┴───────────────────┘
 
-
            STANDARD Stack
 ┌──────────────┬───────────────────┐
 │ Dependency 1 │ fastapi           │
@@ -86,7 +84,6 @@ Available Stacks and Dependencies:
 │ Dependency 7 │ pydantic-settings │
 └──────────────┴───────────────────┘
 
-
              FULL Stack
 ┌──────────────┬───────────────────┐
 │ Dependency 1 │ fastapi           │
@@ -100,16 +97,17 @@ Available Stacks and Dependencies:
 │ Dependency 9 │ pydantic-settings │
 └──────────────┴───────────────────┘
 
-
 Select stack (minimal, standard, full): minimal
 Do you want to proceed with project creation? [y/N]: y
 FastAPI project will deploy at '~your-project-path~'
-╭─────────────────────────── Info ────────────────────────────╮
-│ ℹ Injected metadata into setup.py                           │
-╰─────────────────────────────────────────────────────────────╯
-╭─────────────────────────── Info ────────────────────────────╮
-│ ℹ Injected metadata into config file                        │
-╰─────────────────────────────────────────────────────────────╯
+
+╭──────────────────────── Info ────────────────────────╮
+│ ℹ Injected metadata into setup.py                    │
+╰──────────────────────────────────────────────────────╯
+╭──────────────────────── Info ────────────────────────╮
+│ ℹ Injected metadata into config file                 │
+╰──────────────────────────────────────────────────────╯
+
         Creating Project:
        my-awesome-project
 ┌───────────────────┬───────────┐
@@ -119,32 +117,36 @@ FastAPI project will deploy at '~your-project-path~'
 │ pydantic          │ ✓         │
 │ pydantic-settings │ ✓         │
 └───────────────────┴───────────┘
+
 Creating virtual environment...
-╭─────────────────────────── Info ────────────────────────────╮
-│ ℹ venv created at                                           │
-│ ~your-project-path~/my-awesome-project/.venv                │
-│ To activate the virtual environment, run:                   │
-│                                                             │
-│     source                                                  │
-│ ~your-project-path~/my-awesome-project/.venv/bin/activate   │
-╰─────────────────────────────────────────────────────────────╯
+
+╭──────────────────────── Info ────────────────────────╮
+│ ℹ venv created at                                    │
+│ ~your-project-path~/my-awesome-project/.venv         │
+│ To activate the virtual environment, run:            │
+│                                                      │
+│     source                                           │
+│ ~your-project-path~/my-awesome-project/.venv/bin/act │
+│ ivate                                                │
+╰──────────────────────────────────────────────────────╯
+
 Installing dependencies...
 ⠙ Setting up project environment...Collecting <packages~>
 
 ---> 100%
 
-╭────────────────────────── Success ──────────────────────────╮
-│ ✨ Dependencies installed successfully                      │
-╰─────────────────────────────────────────────────────────────╯
-╭────────────────────────── Success ──────────────────────────╮
-│ ✨ FastAPI project 'my-awesome-project' has been created    │
-│ successfully and saved to                                   │
-│ ~your-project-path~!                                        │
-╰─────────────────────────────────────────────────────────────╯
-╭─────────────────────────── Info ────────────────────────────╮
-│ ℹ To start your project, run 'fastkit runserver' at newly   │
-│ created FastAPI project directory                           │
-╰─────────────────────────────────────────────────────────────╯
+╭─────────────────────── Success ───────────────────────╮
+│ ✨ Dependencies installed successfully                │
+╰───────────────────────────────────────────────────────╯
+╭─────────────────────── Success ───────────────────────╮
+│ ✨ FastAPI project 'my-awesome-project' has been      │
+│ created successfully and saved to                     │
+│ ~your-project-path~!                                  │
+╰───────────────────────────────────────────────────────╯
+╭──────────────────────── Info ────────────────────────╮
+│ ℹ To start your project, run 'fastkit runserver' at  │
+│ newly created FastAPI project directory              │
+╰──────────────────────────────────────────────────────╯
 ```
 
 </div>
@@ -169,13 +171,14 @@ $ fastkit addroute my-awesome-project user
 └──────────────────┴──────────────────────────────────────────┘
 
 Do you want to add route 'user' to project 'my-awesome-project'? [Y/n]: y
-╭─────────────────────────── Info ────────────────────────────╮
-│ ℹ Updated main.py to include the API router                 │
-╰─────────────────────────────────────────────────────────────╯
-╭────────────────────────── Success ──────────────────────────╮
-│ ✨ Successfully added new route 'user' to project           │
-│ `my-awesome-project`                                        │
-╰─────────────────────────────────────────────────────────────╯
+
+╭──────────────────────── Info ────────────────────────╮
+│ ℹ Updated main.py to include the API router          │
+╰──────────────────────────────────────────────────────╯
+╭─────────────────────── Success ───────────────────────╮
+│ ✨ Successfully added new route 'user' to project     │
+│ `my-awesome-project`                                  │
+╰───────────────────────────────────────────────────────╯
 ```
 
 </div>
@@ -200,7 +203,6 @@ Deploying FastAPI project using 'fastapi-default' template
 Template path:
 /~fastapi_fastkit-package-path~/fastapi_project_template/fastapi-default
 
-
            Project Information
 ┌──────────────┬─────────────────────────┐
 │ Project Name │ my-awesome-demo         │
@@ -209,7 +211,6 @@ Template path:
 │ Description  │ My awesome FastAPI demo │
 └──────────────┴─────────────────────────┘
 
-
        Template Dependencies
 ┌──────────────┬───────────────────┐
 │ Dependency 1 │ fastapi           │
@@ -224,13 +225,14 @@ FastAPI template project will deploy at '~your-project-path~'
 
 ---> 100%
 
-╭────────────────────────── Success ──────────────────────────╮
-│ ✨ Dependencies installed successfully                      │
-╰─────────────────────────────────────────────────────────────╯
-╭────────────────────────── Success ──────────────────────────╮
-│ ✨ FastAPI project 'my-awesome-demo' from 'fastapi-default' │
-│ has been created and saved to ~your-project-path~!          │
-╰─────────────────────────────────────────────────────────────╯
+╭─────────────────────── Success ───────────────────────╮
+│ ✨ Dependencies installed successfully                │
+╰───────────────────────────────────────────────────────╯
+╭─────────────────────── Success ───────────────────────╮
+│ ✨ FastAPI project 'my-awesome-demo' from             │
+│ 'fastapi-default' has been created and saved to       │
+│ ~your-project-path~!                                  │
+╰───────────────────────────────────────────────────────╯
 ```
 
 </div>

docs/index.md

@@ -44,6 +44,10 @@ plugins:
   # Material for MkDocs
   - search
 
+nav:
+  - Home: index.md
+  - Changelog: changelog.md
+
 markdown_extensions:
   # Python Markdown
   - abbr
@@ -52,13 +56,13 @@ markdown_extensions:
   - md_in_html
   - mdx_include
   # PyMdown Extensions
-  - pymdownx.highlight:
+  - pymdownx.highlight:  # necessary for code blocks & termynal
       anchor_linenums: true
       line_spans: __span
       pygments_lang_class: true
-  - pymdownx.inlinehilite
-  - pymdownx.snippets
-  - pymdownx.superfences
+  - pymdownx.inlinehilite  # necessary for code blocks & termynal
+  - pymdownx.snippets  # necessary for code blocks & termynal
+  - pymdownx.superfences  # necessary for code blocks & termynal
 
 extra_css:
   - css/termynal.css