Fix release notes + version in docs (fastmachinelearning#742)

* Fix release notes?

* upload artifact

* try global git config

* try more tricks

* don't take ownership

* Edit on GitHub

Author: jmduarte

.github/workflows/build-sphinx.yml

@@ -14,8 +14,13 @@ jobs:
       with:
         fetch-depth: 0
         ref: ${{ github.event.pull_request.head.sha }}
+    - name: Allow for file ownership conflicts with Docker and GitHub Actions
+      run: git config --global --add safe.directory '*'
     - uses: jmduarte/sphinx-action@main
+      env:
+        SPHINX_GITHUB_CHANGELOG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:
+        pre-build-command: "git config --system --add safe.directory '*'"
         docs-folder: "docs/"
     - name: Commit Documentation Changes
       run: |

.github/workflows/test-sphinx.yml

@@ -14,6 +14,14 @@ jobs:
       with:
         fetch-depth: 0
         ref: ${{ github.event.pull_request.head.sha }}
+    - name: Allow for file ownership conflicts with Docker and GitHub Actions
+      run: git config --global --add safe.directory '*'
     - uses: jmduarte/sphinx-action@main
+      env:
+        SPHINX_GITHUB_CHANGELOG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:
+        pre-build-command: "git config --system --add safe.directory '*'"
         docs-folder: "docs/"
+    - uses: actions/upload-artifact@v3
+      with:
+        path: docs/_build/html

docs/conf.py

@@ -72,9 +72,8 @@ def get_pypi_version(package, url_pattern=URL_PATTERN):
     'sphinx_github_changelog',
 ]
 
-# Note: to build locally, you will need to set the ACTIONS_RUNTIME_TOKEN
+# Note: to build locally, you will need to set the SPHINX_GITHUB_CHANGELOG_TOKEN
 # environment variable to a personal access token with repo scope
-sphinx_github_changelog_token = os.environ["ACTIONS_RUNTIME_TOKEN"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -117,3 +116,11 @@ def get_pypi_version(package, url_pattern=URL_PATTERN):
     'includehidden': True,
     'titles_only': False,
 }
+
+html_context = {
+    'display_github': True,  # Integrate GitHub
+    'github_user': 'fastmachinelearning',  # Username
+    'github_repo': "hls4ml",  # Repo name
+    'github_version': 'main',  # Version
+    'conf_py_path': '/docs/',  # Path in the checkout to the docs root
+}