update

docs/index.md

@@ -4,23 +4,23 @@
 [kiui](https://kiui.moe/)'s notebook.
 
 ## Recent Updates
-- [sphinx_doc.md](python\sphinx_doc/) <div style="text-align: right">2024-01-11 23:59:04.735043</div>
-- [basics.md](godot\basics/) <div style="text-align: right">2024-01-07 13:19:24.855045</div>
-- [rebuttals.md](writings\rebuttals/) <div style="text-align: right">2024-01-07 13:19:24.838534</div>
-- [review.md](writings\review/) <div style="text-align: right">2024-01-07 13:19:24.838534</div>
-- [societal_impact.md](writings\societal_impact/) <div style="text-align: right">2024-01-07 13:19:24.838534</div>
-- [web_overview.md](web\web_overview/) <div style="text-align: right">2024-01-07 13:19:24.837537</div>
-- [xpath.md](web\scrape\xpath/) <div style="text-align: right">2024-01-07 13:19:24.837537</div>
-- [cuda.md](windows\cuda/) <div style="text-align: right">2024-01-07 13:19:24.837537</div>
-- [examples.md](writings\examples/) <div style="text-align: right">2024-01-07 13:19:24.837537</div>
-- [pitfalls.md](writings\pitfalls/) <div style="text-align: right">2024-01-07 13:19:24.837537</div>
-- [trojan-go.md](web\proxy\trojan-go/) <div style="text-align: right">2024-01-07 13:19:24.836251</div>
-- [trojan.md](web\proxy\trojan/) <div style="text-align: right">2024-01-07 13:19:24.836251</div>
-- [rsshub.md](web\rss\rsshub/) <div style="text-align: right">2024-01-07 13:19:24.836251</div>
-- [ttrss.md](web\rss\ttrss/) <div style="text-align: right">2024-01-07 13:19:24.836251</div>
-- [grab.md](web\scrape\grab/) <div style="text-align: right">2024-01-07 13:19:24.836251</div>
-- [concepts.md](web\proxy\concepts/) <div style="text-align: right">2024-01-07 13:19:24.835251</div>
-- [frp_reverse_proxy.md](web\proxy\frp_reverse_proxy/) <div style="text-align: right">2024-01-07 13:19:24.835251</div>
-- [set_usual_apps_proxy.md](web\proxy\set_usual_apps_proxy/) <div style="text-align: right">2024-01-07 13:19:24.835251</div>
-- [ss.md](web\proxy\ss/) <div style="text-align: right">2024-01-07 13:19:24.835251</div>
-- [ip.md](web\ip/) <div style="text-align: right">2024-01-07 13:19:24.834251</div>
+- [pypi_publish.md](python\pypi_publish/) <div style="text-align: right">2024-01-12 15:31:40.094346</div>
+- [blender_script.md](blender\blender_script/) <div style="text-align: right">2024-01-12 15:31:38.915473</div>
+- [mkdocs.md](python\mkdocs/) <div style="text-align: right">2023-12-29 14:32:16.436796</div>
+- [trojan.md](web\proxy\trojan/) <div style="text-align: right">2023-12-29 14:29:49.998239</div>
+- [frp_reverse_proxy.md](web\proxy\frp_reverse_proxy/) <div style="text-align: right">2023-12-29 14:29:49.994726</div>
+- [http.md](web\frontend\html\http/) <div style="text-align: right">2023-12-29 14:29:49.993438</div>
+- [css.md](web\frontend\html\css/) <div style="text-align: right">2023-12-29 14:29:49.990813</div>
+- [html.md](web\frontend\html\html/) <div style="text-align: right">2023-12-29 14:29:49.990813</div>
+- [react-basics.md](web\frontend\react-basics/) <div style="text-align: right">2023-12-29 14:29:49.986814</div>
+- [nodejs_basics.md](web\frontend\nodejs_basics/) <div style="text-align: right">2023-12-29 14:29:49.985230</div>
+- [javascript_basics.md](web\frontend\javascript_basics/) <div style="text-align: right">2023-12-29 14:29:49.984229</div>
+- [javascript_advanced.md](web\frontend\javascript_advanced/) <div style="text-align: right">2023-12-29 14:29:49.982230</div>
+- [nginx.md](web\deploy\nginx/) <div style="text-align: right">2023-12-29 14:29:49.978239</div>
+- [sql_sqlite.md](web\backend\sql_sqlite/) <div style="text-align: right">2023-12-29 14:29:49.977733</div>
+- [python_flask.md](web\backend\python_flask/) <div style="text-align: right">2023-12-29 14:29:49.973222</div>
+- [sql_mysql.md](web\backend\sql_mysql/) <div style="text-align: right">2023-12-29 14:29:49.973222</div>
+- [transformation.md](vision\transformation/) <div style="text-align: right">2023-12-29 14:29:49.969222</div>
+- [golang_basics.md](web\backend\golang_basics/) <div style="text-align: right">2023-12-29 14:29:49.969222</div>
+- [golang_gin.md](web\backend\golang_gin/) <div style="text-align: right">2023-12-29 14:29:49.969222</div>
+- [image_processing.md](vision\image_processing/) <div style="text-align: right">2023-12-29 14:29:49.968036</div>

docs/python/pypi_publish.md

@@ -136,7 +136,7 @@ THE SOFTWARE.
 ```
 
 
-### Publishing
+### Publishing [deprecated! please use workflows]
 
 First, build the distributions by:
 
@@ -184,46 +184,53 @@ setup(
 Now you can run `python setup.py sdist` to check whether it copies your static files.
 
 
-### Automatic publishing with github actions
+### Automatic publishing with github workflows
 
-create workflows at `.github/workflows/pypi-publish.yml`:
+**NOTE: this is updated on 2024.1.12, using pypi trusted publishers.**
 
-```yaml
-# This workflows will upload a Python Package using Twine when a release is created
-# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+First configure your pypi project (https://pypi.org/manage/projects/), click `manage --> Publishing`, and add Github as a new publisher:
+
+![image-20240112152907640](pypi_publish.assets/image-20240112152907640.png)
 
+Then create workflows at `.github/workflows/pypi-publish.yml`:
+
+```yaml
 name: Upload Python Package
 
 on:
-  release:
+  release: # publish when releasing a new tag on github.
     types: [created]
+  workflow_dispatch: # allow you to manually trigger this workflow from github.
 
 jobs:
   deploy:
 
     runs-on: ubuntu-latest
 
+    environment:
+      name: pypi
+      url: https://pypi.org/project/kiui/
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v3
       with:
-        python-version: '3.x'
-    - name: Install dependencies
+        python-version: '3.10'
+    # prepare distributions in dist/
+    - name: Install dependencies and Build
       run: |
         python -m pip install --upgrade pip
-        pip install setuptools wheel twine
-    - name: Build and publish
-      env:
-        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-      run: |
+        pip install setuptools wheel
         python setup.py sdist bdist_wheel
-        twine upload dist/*
+    # publish by trusted publishers (need to first setup in pypi.org projects-manage-publishing!)
+    # ref: https://github.com/marketplace/actions/pypi-publish
+    - name: Publish package distributions to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
 ```
 
-Create secrets at repository.
-
 When you want to publish a new version, navigate to **release** and release a version tag.
 
 Then github actions will build and publish current repository state automatically!