Monorepo for Tangled tangled.org

`org.tangled.track.release` #4783

Open boltless.me
Open opened by boltless.me

Not to replace current tags but to introduce extra layer on top of it with /releases and /releases/{id} pages.

Reason #

git annotated tag has 3 problems. 2 limitations and 1 issue.

  • We can't support rich text there because it is semantically plaintext and NOT markdown.
    Well, we can probably introduce something like Markup-Format: commonmark trailer, but that will still lack features like image upload or user/ticket mentions (due to how TFM works.) To support full TFM spec, we need org.tangled.markup.markdown object.
  • We can't support extra metadata

    what metadata?

    • basic flags like:
      • prerelease
      • make_latest
      • hide_artifact_links
    • link to milestones
    • audit informations like gitlab's evidences
  • Attachments are loosely linked.
    Because org.tangled.repo.artifact currently use object-id but not all tags have their own object-id (only annotated tags do,) Artifacts are not directly linked to the target tag. Both point to specific commit-id and we match on that. But, lightweight tags can technically move to different commit.

Spec #

record-key #

any format.

Same name from git tag is preferred but usually normalized. So tags like sdk/trace/v1.31.0 will have sidecar release record sdk-trace-v1.31.0. Note that this is not how release objects will point to a tag.

Record example: #

{
  "$type": "org.tangled.track.release",
  "subject": {
    "$type": "#tag",
    "tag": "sdk/trace/v1.31.0"
  },
  "title": {
    "$type": "org.tangled.markup.markdown#inline",
    "text": "sdk/trace: `v1.31.0`"
  },
  "body": {
    "$type": "org.tangled.markup.markdown",
    "text": "..."
  },
  "attachments": [
    { "$type": "#attachment", "filename": "...", "blob": { } },
    { "$type": "#attachment", "filename": "...", "blob": { } }
  ],
  "createdAt": "..."
}
  • release can have rich title and body, similar to tickets.
  • attachments are inlined so tagger can sign whole record including the uploaded attachments.

Open questions #

Should we mix releases and tags in one list like GitHub does? #

Pros #

  • They serve same role and few devs might not even use releases, so merging everything into "tag" is good.
  • "latest" works like imaginary tag

Cons #

  • Tags and releases are not same. It's wrong to serve release content when path literally says /tags/*. Even if we use it like sidecar record (similar to what we are doing with org.tangled.repo.artifact today,) those are not really part of tag while rendered as if they are. This will introduce same problem from GitHub.
  • "latest" works like imaginary tag while it's not.
Sign up or Sign in to add to the discussion.