Merge pull request #35 from kip93/feature/non-tags

Add support for non-tagged publishing

Author: domenkozar

backend/flakestry/api/publish.py

@@ -15,7 +15,8 @@
 
 
 class Publish(BaseModel):
-    version: str
+    ref: str | None
+    version: str | None
     metadata: dict[str, Any] | None
     metadata_errors: str | None
     readme: str | None
@@ -46,18 +47,55 @@ def publish(
     # content={"message": "Private repositories are not supported, \
     # see https://github.com/flakestry/flakestry.dev/issues"})
 
+    github_headers = {
+        "Authorization": f"Bearer {github_token}",
+        "X-GitHub-Api-Version": "2022-11-28",
+        "Accept": "application/vnd.github+json",
+    }
+
+    owner_name, repository_name = token.repository.split("/")
+    if publish.ref:
+        ref = publish.ref
+    elif publish.version:
+        ref = f"refs/tags/{publish.version}"
+    else:
+        return JSONResponse(
+            status_code=status.HTTP_400_BAD_REQUEST,
+            content={"message": 'Neither "ref" nor "version" were provided'},
+        )
+
+    # Get info on the commit to be published
+    commit_response = requests.get(
+        f"https://api.github.com/repos/{owner_name}/{repository_name}/commits/{ref}",
+        headers=github_headers,
+    )
+    commit_response.raise_for_status()
+    commit_json = commit_response.json()
+    commit_sha = commit_json["sha"]
+    commit_date = commit_json["commit"]["committer"]["date"]
+
+    # Validate & parse version
+    datetime = re.sub(r"[^0-9]", "", commit_date)
+    if publish.version:
+        given_version = publish.version.format(
+            datetime=datetime,
+            date=datetime[:8],
+            time=datetime[8:],
+        )
+    elif publish.ref and publish.ref.startswith("refs/tags/"):
+        given_version = publish.ref.removeprefix("refs/tags/")
+    else:
+        given_version = f"v0.1.{datetime}"
+
     version_regex = r"^v?([0-9]+\.[0-9]+\.?[0-9]*$)"
-    version = re.search(version_regex, publish.version)
+    version = re.search(version_regex, given_version)
     if not version:
         return JSONResponse(
             status_code=status.HTTP_400_BAD_REQUEST,
-            content={
-                "message": f"{publish.version} doesn't match regex {version_regex}"
-            },
+            content={"message": f"{given_version} doesn't match regex {version_regex}"},
         )
     else:
         version = version.groups()[0]
-    owner_name, repository_name = token.repository.split("/")
 
     # Create owner if it doesn't exist
     owner = session.exec(
@@ -81,45 +119,24 @@ def publish(
         session.commit()
         session.refresh(repo)
 
-    # 400 if version already exists
+    # 409 if version already exists
     if session.exec(
         select(Release)
         .where(Release.version == version)
         .where(Release.repo_id == repo.id)
     ).first():
         return JSONResponse(
-            status_code=status.HTTP_400_BAD_REQUEST,
-            content={"message": f"Version {publish.version} already exists"},
-        )
-
-    github_headers = {
-        "Authorization": f"Bearer {github_token}",
-        "X-GitHub-Api-Version": "2022-11-28",
-        "Accept": "application/vnd.github+json",
-    }
-    ref_response = requests.get(
-        f"https://api.github.com/repos/{owner_name}/{repository_name}/git/ref/tags/{publish.version}",
-        headers=github_headers,
-    )
-    ref_response.raise_for_status()
-    commit = ref_response.json()["object"]["sha"]
-
-    if ref_response.json()["object"]["type"] == "tag":
-        # now we get the commit sha
-        tag_response = requests.get(
-            f"https://api.github.com/repos/{owner_name}/{repository_name}/git/tags/{commit}",
-            headers=github_headers,
+            status_code=status.HTTP_409_CONFLICT,
+            content={"message": f"Version {version} already exists"},
         )
-        tag_response.raise_for_status()
-        commit = tag_response.json()["object"]["sha"]
 
     # index README
     try:
         description = publish.metadata["description"]
     except Exception:
         description = None
 
-    path = f"{owner_name}/{repository_name}/{commit}/{publish.readme}"
+    path = f"{owner_name}/{repository_name}/{commit_sha}/{publish.readme}"
     if publish.readme:
         readme_response = requests.get(
             f"https://raw.githubusercontent.com/{path}", headers=github_headers
@@ -129,12 +146,13 @@ def publish(
     else:
         readme = None
 
+    # Do release
     release = Release(
         repo_id=repo.id,
         version=version,
         readme_filename=publish.readme,
         readme=readme,
-        commit=commit,
+        commit=commit_sha,
         description=description,
         meta_data=publish.metadata,
         meta_data_errors=publish.metadata_errors,
@@ -145,6 +163,7 @@ def publish(
     session.commit()
     session.refresh(release)
 
+    # Index release
     document = {
         "description": description,
         "readme": readme,

frontend/src/Pages/Publish.elm

@@ -15,16 +15,33 @@ page =
             [ Flakestry.Layout.viewNav
             , main_ []
                 [ div
-                    [ class "container px-4 max-w-5xl" ]
+                    [ class "container px-4 py-24 max-w-5xl" ]
                     [ h1
-                        [ class "py-24 text-4xl font-semibold md:text-center"
-                        ]
+                        [ class "text-4xl font-semibold md:text-center" ]
+                        [ text "Publish your Flake" ]
+                    , p
+                        [ class "mt-6 text-l text-slate-600" ]
+                        [ text """
+                            Currently it's possible to publish flakes via GitHub actions.
+                            Here're a few examples on how to make use of it to release your very own flakes.
+                        """ ]
+                    , h2
+                        [ class "max-w-3xl flex items-center pt-12 text-2xl text-slate-900 font-semibold py-4" ]
                         [ text "Publish your Flake for each tag" ]
                     , File.defaultOptions
                         |> File.fileName ".github/workflows/publish.yaml"
                         |> File.language "yaml"
-                        |> File.contents publishFlakeYaml
-                        |> File.setCopyableContents (Just publishFlakeYaml)
+                        |> File.contents publishTaggedFlakeYaml
+                        |> File.setCopyableContents (Just publishTaggedFlakeYaml)
+                        |> File.view
+                    , h2
+                        [ class "max-w-3xl flex items-center pt-12 text-2xl text-slate-900 font-semibold py-4" ]
+                        [ text "Publish your Flake for each push to the default branch" ]
+                    , File.defaultOptions
+                        |> File.fileName ".github/workflows/publish.yaml"
+                        |> File.language "yaml"
+                        |> File.contents publishRollingFlakeYaml
+                        |> File.setCopyableContents (Just publishRollingFlakeYaml)
                         |> File.view
                     ]
                 ]
@@ -33,8 +50,8 @@ page =
     }
 
 
-publishFlakeYaml : String
-publishFlakeYaml =
+publishTaggedFlakeYaml : String
+publishTaggedFlakeYaml =
     """name: "Publish a flake to flakestry"
 on:
     push:
@@ -58,3 +75,29 @@ jobs:
               with:
                   version: "${{ inputs.tag || github.ref_name }}"
 """
+
+
+publishRollingFlakeYaml : String
+publishRollingFlakeYaml =
+    """name: "Publish a flake to flakestry"
+on:
+    push:
+        branches:
+            - main
+    workflow_dispatch:
+        inputs:
+            ref:
+                description: "The existing reference to publish"
+                type: "string"
+                required: true
+jobs:
+    publish-flake:
+        runs-on: ubuntu-latest
+        permissions:
+            id-token: "write"
+            contents: "read"
+        steps:
+            - uses: flakestry/flakestry-publish@main
+              with:
+                ref: "${{ inputs.ref || github.ref }}"
+"""