Add release workflow and changelog (#115)

Author: andreasgerstmayr

.github/workflows/continuous-integration.yaml renamed to .github/workflows/continuous-integration.yml

@@ -12,12 +12,14 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v5
+    - name: Checkout
+      uses: actions/checkout@v5
 
     - name: Install uv
-      uses: astral-sh/setup-uv@v6
+      uses: astral-sh/setup-uv@v7
 
-    - uses: actions/setup-node@v5
+    - name: Install Node.js
+      uses: actions/setup-node@v5
       with:
         node-version-file: .node-version
 

.github/workflows/release.yml

@@ -0,0 +1,66 @@
+name: Release
+
+on:
+  push:
+    tags:
+    - "v*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v5
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v6
+
+    - name: Build release distributions
+      run: uv build
+
+    - name: Upload release dists
+      uses: actions/upload-artifact@v4
+      with:
+        name: release-dists
+        path: dist/
+
+  publish:
+    runs-on: ubuntu-latest
+    needs:
+    - build
+    permissions:
+      # required to create a short-lived OIDC token used for PyPI auth
+      id-token: write
+    steps:
+    - name: Fetch release distributions
+      uses: actions/download-artifact@v5
+      with:
+        name: release-dists
+        path: dist/
+
+    - name: Publish release distributions to PyPI
+      uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # v1.13.0
+
+  announce:
+    runs-on: ubuntu-latest
+    needs:
+    - publish
+    permissions:
+      # required to create the release on GitHub
+      contents: write
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v5
+
+    - name: Create Release on GitHub
+      run: |
+        RELEASE_NOTES=$(awk -v ver="${VERSION}" '/^## / {cur=$2; next} cur == ver {print}' CHANGELOG.md)
+        PRERELEASE_ARG=""
+        if [[ "${VERSION}" == *beta* ]]; then
+          PRERELEASE_ARG="--prerelease"
+        fi
+
+        gh release create "${VERSION}" --title "${VERSION}" --notes "${RELEASE_NOTES}" ${PRERELEASE_ARG}
+      env:
+        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        VERSION: ${{ github.ref_name }}

CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## v1.1.0 (2025-10-15)
+* publish releases to [PyPI](https://pypi.org/project/fava-dashboards/)
+
+## v1.0.0 (2023-03-08)
+* initial version

README.md

@@ -1,19 +1,20 @@
 # Fava Dashboards
-[![Continuous Integration](https://github.com/andreasgerstmayr/fava-dashboards/actions/workflows/continuous-integration.yaml/badge.svg)](https://github.com/andreasgerstmayr/fava-dashboards/actions/workflows/continuous-integration.yaml)
+[![Continuous Integration](https://github.com/andreasgerstmayr/fava-dashboards/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/andreasgerstmayr/fava-dashboards/actions/workflows/continuous-integration.yml)
+[![PyPI](https://img.shields.io/pypi/v/fava-dashboards)](https://pypi.org/project/fava-dashboards/)
 
 fava-dashboards allows creating custom dashboards in [Fava](https://github.com/beancount/fava).
 
 Example dashboards with random data:
-[![Overview](frontend/tests/e2e/dashboards.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Overview-1-chromium-linux.png)](frontend/tests/e2e/dashboards.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Overview-1-chromium-linux.png)
-[![Assets](frontend/tests/e2e/dashboards.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Assets-1-chromium-linux.png)](frontend/tests/e2e/dashboards.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Assets-1-chromium-linux.png)
-[![Income and Expenses](frontend/tests/e2e/dashboards.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Income-and-Expenses-1-chromium-linux.png)](frontend/tests/e2e/dashboards.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Income-and-Expenses-1-chromium-linux.png)
-[![Travelling](frontend/tests/e2e/dashboards.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Travelling-1-chromium-linux.png)](frontend/tests/e2e/dashboards.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Travelling-1-chromium-linux.png)
-[![Sankey](frontend/tests/e2e/dashboards.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Sankey-1-chromium-linux.png)](frontend/tests/e2e/dashboards.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Sankey-1-chromium-linux.png)
-[![Projection](frontend/tests/e2e/dashboards.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Projection-1-chromium-linux.png)](frontend/tests/e2e/dashboards.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Projection-1-chromium-linux.png)
+[![Overview](https://github.com/andreasgerstmayr/fava-dashboards/raw/main/frontend/tests/e2e/dashboards.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Overview-1-chromium-linux.png)](https://github.com/andreasgerstmayr/fava-dashboards/raw/main/frontend/tests/e2e/dashboards.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Overview-1-chromium-linux.png)
+[![Assets](https://github.com/andreasgerstmayr/fava-dashboards/raw/main/frontend/tests/e2e/dashboards.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Assets-1-chromium-linux.png)](https://github.com/andreasgerstmayr/fava-dashboards/raw/main/frontend/tests/e2e/dashboards.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Assets-1-chromium-linux.png)
+[![Income and Expenses](https://github.com/andreasgerstmayr/fava-dashboards/raw/main/frontend/tests/e2e/dashboards.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Income-and-Expenses-1-chromium-linux.png)](https://github.com/andreasgerstmayr/fava-dashboards/raw/main/frontend/tests/e2e/dashboards.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Income-and-Expenses-1-chromium-linux.png)
+[![Travelling](https://github.com/andreasgerstmayr/fava-dashboards/raw/main/frontend/tests/e2e/dashboards.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Travelling-1-chromium-linux.png)](https://github.com/andreasgerstmayr/fava-dashboards/raw/main/frontend/tests/e2e/dashboards.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Travelling-1-chromium-linux.png)
+[![Sankey](https://github.com/andreasgerstmayr/fava-dashboards/raw/main/frontend/tests/e2e/dashboards.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Sankey-1-chromium-linux.png)](https://github.com/andreasgerstmayr/fava-dashboards/raw/main/frontend/tests/e2e/dashboards.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Sankey-1-chromium-linux.png)
+[![Projection](https://github.com/andreasgerstmayr/fava-dashboards/raw/main/frontend/tests/e2e/dashboards.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Projection-1-chromium-linux.png)](https://github.com/andreasgerstmayr/fava-dashboards/raw/main/frontend/tests/e2e/dashboards.test.ts-snapshots/PNG-Snapshot-Tests-Light-Theme-Projection-1-chromium-linux.png)
 
 ## Installation
 ```
-pip install git+https://github.com/andreasgerstmayr/fava-dashboards.git
+pip install fava-dashboards
 ```
 
 Enable this plugin in Fava by adding the following lines to your ledger:

pyproject.toml

@@ -2,20 +2,32 @@
 name = "fava-dashboards"
 dynamic = ["version"]
 description = "Custom Dashboards for Beancount in Fava"
+readme = "README.md"
+license = {text = "MIT License"}
+license-files = [
+  "LICENSE.md",
+]
 authors = [
     { name = "Andreas Gerstmayr", email = "[email protected]" }
 ]
+keywords = ["fava", "beancount", "portfolio", "investment", "returns"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Financial and Insurance Industry",
+    "Topic :: Office/Business :: Financial :: Accounting",
+    "Topic :: Office/Business :: Financial :: Investment",
+]
+requires-python = ">= 3.8"
 dependencies = [
     "fava>=1.26.1",
     "pyyaml>=6.0.1",
     "beanquery>=0.1.0",
 ]
-readme = "README.md"
-requires-python = ">= 3.8"
-license = {text = "MIT License"}
 
 [project.urls]
 Source = "https://github.com/andreasgerstmayr/fava-dashboards"
+Issues = "https://github.com/andreasgerstmayr/fava-dashboards/issues"
+Changelog = "https://github.com/andreasgerstmayr/fava-dashboards/blob/main/CHANGELOG.md"
 
 [build-system]
 requires = ["hatchling", "hatch-vcs"]