From 540871f343d0a9734251bb46c0cf4a34bab55a38 Mon Sep 17 00:00:00 2001
From: Philip Loche <philip.loche@posteo.de>
Date: Thu, 5 Dec 2024 09:15:15 +0100
Subject: [PATCH] Add Changelog (#116)

---
 .github/workflows/docs.yml        |  7 ++++---
 docs/src/references/changelog.rst | 26 ++++++++++++++++++++++++++
 docs/src/references/index.rst     |  1 +
 pyproject.toml                    |  6 ++++--
 4 files changed, 35 insertions(+), 5 deletions(-)
 create mode 100644 docs/src/references/changelog.rst

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 2c0da4a3..2e423f0c 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -9,6 +9,8 @@ on:
 
 jobs:
   build:
+    permissions:
+      contents: write
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -17,13 +19,12 @@ jobs:
         with:
           python-version: "3.12"
       - name: install dependencies
-        run: |
-          python -m pip install tox
+        run: python -m pip install tox
       - name: build documentation
         run: tox -e docs
       - name: put documentation in the website
         run: |
-          git clone https://oauth2:${{ secrets.GITHUB_TOKEN }}@github.com/$GITHUB_REPOSITORY --branch gh-pages gh-pages
+          git clone https://github.com/$GITHUB_REPOSITORY --branch gh-pages gh-pages
           rm -rf gh-pages/.git
           cd gh-pages
 
diff --git a/docs/src/references/changelog.rst b/docs/src/references/changelog.rst
new file mode 100644
index 00000000..815bcef9
--- /dev/null
+++ b/docs/src/references/changelog.rst
@@ -0,0 +1,26 @@
+.. _userdoc-changelog:
+
+Changelog
+=========
+
+All notable changes to ``torch-pme`` are documented here, following the `keep a
+changelog <https://keepachangelog.com/en/1.1.0/>`_ format. This project follows
+`Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.
+
+
+`Unreleased <https://github.com/lab-cosmo/torch-pme/>`_
+-------------------------------------------------------
+
+Added
+#####
+
+* First release outside of the lab.
+
+.. Fixed
+.. #####
+
+.. Changed
+.. #######
+
+.. Removed
+.. #######
diff --git a/docs/src/references/index.rst b/docs/src/references/index.rst
index 0f62b95c..c4b1461d 100644
--- a/docs/src/references/index.rst
+++ b/docs/src/references/index.rst
@@ -14,3 +14,4 @@ refer to the :ref:`userdoc-how-to` section.
     metatensor
     lib/index
     utils/index
+    changelog
diff --git a/pyproject.toml b/pyproject.toml
index 31ad40a4..83e46326 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -24,6 +24,7 @@ classifiers = [
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
     "Topic :: Scientific/Engineering",
     "Topic :: Scientific/Engineering :: Physics",
     "Topic :: Scientific/Engineering :: Chemistry",
@@ -60,10 +61,11 @@ examples = [
 metatensor = ["metatensor-torch <0.7,>=0.6"]
 
 [project.urls]
-homepage = "http://torch-pme.readthedocs.io"
-documentation = "http://torch-pme.readthedocs.io"
+homepage = "https://lab-cosmo.github.io/torch-pme"
+documentation = "https://lab-cosmo.github.io/torch-pme"
 repository = "https://github.com/lab-cosmo/torch-pme"
 issues = "https://github.com/lab-cosmo/torch-pme/issues"
+changelog = "https://lab-cosmo.github.io/torch-pme/latest/references/changelog.html"
 
 [tool.coverage.report]
 show_missing = true