WIP: Add releases to the Readme.md (or other file) in form of mermaid graph

[an3l]

• Release cycle may be tracked as graph by using mermaid block that is automatically rendered by GitHub.

• Use release chart as part of codebase.

• The graph may be mainted by the branch and/or have specific Releases.md file for one or more brances (1x.y)

• Sure correct dates and formats have to be corrected (so it is wip).

• Reviewer: ian@mariadb.org

See Readme.md in GitHub

[vuvova]

FYI, going to https://github.com/an3l/server/tree/anel-releases-graph I get

Unable to render rich display
Invalid date:CRITICAL 2023-04-11

[an3l]

FYI, going to https://github.com/an3l/server/tree/anel-releases-graph I get

Unable to render rich display
Invalid date:CRITICAL 2023-04-11

Weird, it works for me on the same branch:

The same block should also render here in comments :

gantt
    title Releases for 2023
    section 10.11
      10.11 (RC)        :crit, CRITICAL         2023-04-11, 2d
      WAITING           :milestone, crit            after CRITICAL
    section 10.6
      10.6 (GA)         :active, IN_DEVELOPMENT      2023-04-12, 2d
    section 10.4
      10.4              :done, RELEASED    2023-04-13, 1d
      Released          :milestone,done    after RELEASED

Loading

Seems that problem in your case (for some reason) is scheduling tasks after another completed tasks with usage of after (simulating predecessor relationship).
We can remove that thing and use exact dates , so below should be rendered also for you (right?):

gantt
    title Releases for 2023
    section 10.11
      10.11 (RC)        :crit,         2023-04-11, 2d
      WAITING           :milestone,crit             2023-04-13,2023-04-13
    section 10.6
      10.6 (GA)         :active,      2023-04-12, 2d
    section 10.4
      10.4              :done    2023-04-13, 1d
      Released          :milestone,done      2023-04-14, 2023-04-14

Loading

[vuvova]

All I see is

[an3l]

I will take a look, thanks.

[an3l]

So looking into github and mermaid it should allow gantt type.
I can see rendered graph from mermaid's documentation

gantt
    apple :a, 2017-07-20, 1w
    banana :crit, b, 2017-07-23, 1d
    cherry :active, c, after b a, 1d

Loading

Now for our example, it should be similar,I added missing commas for proper syntax (although I can see graphs in previous comment).
I can see the graphs in this comment, hope others can too :)

gantt
    title Releases for 2023
    section 10.11
      10.11 (RC)        :crit, c1                , 2023-04-11, 2d
      WAITING           :milestone, m1,  after c1, 1m
    section 10.6
      10.6 (GA)         :active, a1 , 2023-04-12, 2d
    section 10.4
      10.4              :done, r1 , 2023-04-13, 1d
      Released          :milestone,done , after r1, 1m

Loading

[vuvova]

Yes, the last comment looks fine, thanks

[iangilfillan]

@vuvova I still see "Unable to render rich display". But is displaying graphs here a worthwhile effort? It just seems to add a maintenance burden. Judging by this file still containing old KB links, it's almost guaranteed to fall behind.

[vuvova]

I also see "Unable to render rich display". But the reason is Invalid date:IN_DEVELOPMENT 2023-04-12 so I suspect with some tweaking it'll work.

Whether it's a worthwhile effort? I wouldn't spend time on it. But it's bright and eye-catching, I can see why someone might want to have it. It's relatively easy to ensure that it won't fall behind, for example, cmake can check that README.md always has at least a year worth of dates.