Merge pull request #12 from 1.2.x

Author: takos22

.github/actions/changelog/Dockerfile

@@ -0,0 +1,6 @@
+FROM python:3
+COPY requirements.txt /requirements.txt
+RUN pip install -r /requirements.txt
+
+COPY main.py /main.py
+CMD ["python", "/main.py"]

.github/actions/changelog/action.yml

@@ -0,0 +1,10 @@
+name: "Generate CHANGELOG.rst"
+description: "Generate the CHANGELOG.tst file from docs/changelog.rst"
+author: "Takos22 <[email protected]>"
+inputs:
+  token:
+    description: "Token for the repo. Can be passed in using {{ secrets.GITHUB_TOKEN }}"
+    required: true
+runs:
+  using: "docker"
+  image: "Dockerfile"

.github/actions/changelog/main.py

@@ -0,0 +1,110 @@
+import re
+import traceback
+import typing
+
+from github import Github
+from pydantic import BaseSettings, SecretStr
+from sphobjinv import Inventory
+
+docs_url = "https://codingame.readthedocs.io/en/latest/"
+roles = {
+    "attr": "attribute",
+    "meth": "method",
+    "exc": "exception",
+}
+refs = {
+    "async": (
+        "Asynchronous client",
+        "user_guide/quickstart.html#about-the-asynchronous-client",
+    ),
+    "login": (
+        "Login",
+        "user_guide/quickstart.html#login",
+    ),
+}
+
+
+class Settings(BaseSettings):
+    input_token: SecretStr
+    github_repository: str
+    github_ref: str
+
+
+def main():
+    settings = Settings(_env_file=".github/actions/changelog/.env")
+    inventory = Inventory(url=docs_url + "objects.inv")
+    github = Github(settings.input_token.get_secret_value())
+    repo = github.get_repo(settings.github_repository)
+    docs_changelog = repo.get_contents(
+        "docs/changelog.rst", settings.github_ref.split("/")[-1]
+    )
+
+    content = docs_changelog.decoded_content.decode()
+    new_content = content
+    directives: typing.List[re.Match] = list(
+        re.finditer(r":(\w+):`(.+?)`", content)
+    )
+    links: typing.List[str] = []
+
+    for directive in directives:
+        if directive[1] == "ref":
+            links.append("`{} <{}>`__".format(*refs[directive[2]]))
+        else:
+            role = roles.get(directive[1], directive[1])
+            try:
+                index = [
+                    i
+                    for _, i in inventory.suggest(
+                        f":py:{role}:`codingame.{directive[2]}`",
+                        with_index=True,
+                        thresh=90,
+                    )
+                ][0]
+            except IndexError:
+                print(
+                    "::warning file=CHANGELOG.rst:: "
+                    f":py:{role}:`codingame.{directive[2]}` not found"
+                )
+                links.append(f"``{directive[2]}``")
+                continue
+
+            obj = inventory.objects[index]
+            links.append(
+                f"`{obj.dispname_expanded[len('codingame.'):]} "
+                f"<{docs_url + obj.uri_expanded}>`__"
+            )
+
+    for directive, link in zip(directives[::-1], links[::-1]):
+        new_content = (
+            new_content[: directive.start()]
+            + link
+            + new_content[directive.end() :]  # noqa: E203
+        )
+
+    new_content = new_content[
+        len(".. currentmodule:: codingame\n\n") :  # noqa: E203
+    ]
+
+    changelog = repo.get_contents(
+        "CHANGELOG.rst", settings.github_ref.split("/")[-1]
+    )
+    if new_content != changelog.decoded_content.decode():
+        repo.update_file(
+            changelog.path,
+            "Update CHANGELOG.rst",
+            new_content,
+            changelog.sha,
+            branch=settings.github_ref.split("/")[-1],
+        )
+
+
+if __name__ == "__main__":
+    try:
+        main()
+    except Exception as e:
+        print(
+            "::error file=.github/actions/changelog/main.py,"
+            f"title={e.__class__.__name__}: {str(e)}:: "
+            + traceback.format_exc()
+        )
+        raise e from None

.github/actions/changelog/requirements.txt

@@ -0,0 +1,3 @@
+pygithub
+pydantic
+sphobjinv

.github/workflows/changelog.yml

@@ -0,0 +1,12 @@
+name: Generate CHANGELOG.rst from docs/changelog.rst
+
+on: [push]
+
+jobs:
+  generate-changelog:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ./.github/actions/changelog
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}