diff options
| -rw-r--r-- | .github/workflows/changelog.yml | 47 | ||||
| -rw-r--r-- | CHANGELOG.md | 12 | ||||
| -rw-r--r-- | LICENSE | 2 | ||||
| -rw-r--r-- | docs/source/changelog.md | 5 | ||||
| -rw-r--r-- | docs/source/conf.py | 20 | ||||
| -rw-r--r-- | docs/source/index.md | 2 | ||||
| -rw-r--r-- | docs/source/license.md | 23 | ||||
| -rw-r--r-- | pyproject.toml | 6 |
8 files changed, 103 insertions, 14 deletions
diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml new file mode 100644 index 00000000..b2b02277 --- /dev/null +++ b/.github/workflows/changelog.yml @@ -0,0 +1,47 @@ +name: CHANGELOG + +on: + push: + tags: + - "v*" + # - v[0-9]+.[0-9]+.[0-9]+ + workflow_dispatch: + +jobs: + deploy: + runs-on: ubuntu-latest + permissions: + contents: write + pull-requests: write + id-token: write + steps: + - name: Checkout Code + uses: actions/checkout@v3 + + - name: Update CHANGELOG + id: changelog + uses: requarks/changelog-action@v1 + with: + token: ${{ github.token }} + tag: ${{ github.ref_name }} + includeInvalidCommits: true + changelogFilePath: CHANGELOG.md + writeToFile: true + useGitmojis: false + + - name: Create Release + uses: ncipollo/release-action@v1.12.0 + with: + allowUpdates: true + draft: false + makeLatest: true + name: ${{ github.ref_name }} + body: ${{ steps.changelog.outputs.changes }} + token: ${{ github.token }} + + - name: Commit CHANGELOG.md + uses: stefanzweifel/git-auto-commit-action@v4 + with: + branch: master + commit_message: 'docs: update CHANGELOG.md for ${{ github.ref_name }} [skip ci]' + file_pattern: CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..65ef0655 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,12 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [v2.0.2a3] - 2024-01-28 +### Chores +- [`e288e40`](https://github.com/HydroRoll-Team/infini/commit/e288e4024744b340e2df424a85262706c476a362) - **version**: bump version to 2.0.2a3 *(commit by [@HsiangNianian](https://github.com/HsiangNianian))* + + +[v2.0.2a3]: https://github.com/HydroRoll-Team/infini/compare/v2.0.2-alpha.2...v2.0.2a3
\ No newline at end of file @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2023 HydroRoll-Team +Copyright (c) 2024 HydroRoll-Team & Noctisynth Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/docs/source/changelog.md b/docs/source/changelog.md index efc8cca8..769b66e7 100644 --- a/docs/source/changelog.md +++ b/docs/source/changelog.md @@ -1,5 +1,3 @@ -# 变更日志 - <!-- Version codenames style: @@ -10,3 +8,6 @@ https://patternbasedwriting.com/elementary_writing_success/list-4800-adjectives/ https://en.wikipedia.org/wiki/Lists_of_colors --> + +```{include} ../../CHANGELOG.md +```
\ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index c2403d47..319cfd92 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -19,17 +19,19 @@ with open(PYPROJECT, "r", encoding="utf8") as f: PROJECT_VERSION = DATA["project"]["version"] PROJECT_NAME = DATA["project"]["name"] AUTHOR_TABLE = DATA["project"]["authors"] -AUTHORS = ",".join([f"{aut['name']}<{aut['email']}>" for aut in AUTHOR_TABLE]) +AUTHORS = ",".join([f"{aut['name']}" for aut in AUTHOR_TABLE]) # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -project = PROJECT_NAME # "IamAI" +project = PROJECT_NAME # "Infini" release = PROJECT_VERSION # "latest" -copyright = "2023-PRESENT, HydroRoll-Team." -author = "Hsiang Nianian" # AUTHORS +copyright = ( + "2023-PRESENT, HydroRoll-Team & 浊莲." +) +author = AUTHORS # "Hsiang Nianian" -# html_title = "Who am I? I am AI." +html_title = "INFINI GENERATOR II" # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration @@ -65,7 +67,9 @@ gettext_uuid = True # optional. html_theme = "furo" html_static_path = ["../_static"] -html_logo = "https://cdn.jsdelivr.net/gh/HydroRoll-Team/infini@master/docs/_static/logo.png" +html_logo = ( + "https://cdn.jsdelivr.net/gh/HydroRoll-Team/infini@master/docs/_static/logo.png" +) html_favicon = html_logo html_css_files = [ @@ -74,7 +78,7 @@ html_css_files = [ ] html_theme_options = { - "announcement": "<em><a href='#'>documentation</a> is still under construction now, welcome any <a href='contributing.html'>contribution</a>!</em>", + # "announcement": "<em><a href='#'>documentation</a> is still under construction now, welcome any <a href='contributing.html'>contribution</a>!</em>", "source_repository": "https://github.com/HydroRoll-Team/infini/", "source_branch": "master", "source_directory": "docs/source/", @@ -92,4 +96,4 @@ html_theme_options = { "class": "fa-brands fa-python", }, ], -}
\ No newline at end of file +} diff --git a/docs/source/index.md b/docs/source/index.md index cd1a0d36..7e5fe6f1 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -26,7 +26,7 @@ pages/grps-1/index :caption: API 接口 :hidden: -源码文档 <pages/api/index> +阅读源码 <pages/api/index> ``` ```{toctree} diff --git a/docs/source/license.md b/docs/source/license.md index 1d1521fe..ab2c80e0 100644 --- a/docs/source/license.md +++ b/docs/source/license.md @@ -1,2 +1,21 @@ -```{include} ../../LICENSE -```
\ No newline at end of file +MIT License + +Copyright (c) 2023 HydroRoll-Team & 浊莲 + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/pyproject.toml b/pyproject.toml index 1c0b307c..772a23cc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -14,6 +14,12 @@ requires-python = ">=3.10" readme = "README.md" license = { text = "MIT" } +[project.urls] +Homepage = "https://grps.hydroroll.team" +Documentation = "https://grps.hydroroll.team" +Repository = "https://github.com/HydroRoll-Team/infini" +Changelog = "https://grps.hydroroll.team/zh_CN/latest/changelog.html" + [build-system] requires = ["pdm-backend"] build-backend = "pdm.backend" |