Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@Hipska
Copy link
Contributor

@Hipska Hipska commented Sep 19, 2025

Base information

Question Answer
Related to a SourceForge thead / Another PR / Combodo ticket? 463869b
Type of change? Documentation

Objective

Keep revision history up to date.

Proposed solution

I think a gantt chart would be more practical, both for maintainers (clean code) and users (easy to view when a certain version was released/supported).

If accepted, I'm willing to do the complete conversion up to the version requested. Find hereunder an example of how it would look like up to 2.7 LTS.

gantt
    dateFormat  YYYY-MM-DD
    section 2.7 (LTS)
        2.7.0-beta  :done, 2019-12-18, 2020-01-29
        2.7.0-beta2 :done, 2020-01-29, 2020-04-01
        2.7.0-1     :done, 2020-04-01, 2020-05-20
        2.7.0-2     :done, 2020-05-20, 2020-06-26
        2.7.1       :done, 2020-06-26, 2020-11-10
        2.7.2-1     :done, 2020-11-10, 2020-12-09
        2.7.3       :done, 2020-12-09, 2021-03-31
        2.7.4       :done, 2021-03-31, 2021-07-05
        2.7.5-1     :done, 2021-07-05, 2021-12-17
        2.7.6       :done, 2021-12-17, 2022-07-11
        2.7.7       :done, 2022-07-11, 2022-12-28
        2.7.8       :done, 2022-12-28, 2023-08-10
        2.7.9       :done, 2023-08-10, 2024-01-17
        2.7.10      :done, 2024-01-17, 2024-09-28
        2.7.11      :done, 2024-09-28, 2025-02-25
        2.7.12      :done, 2025-02-25, 2025-09-01
    section 3.0 (STS)
        3.0.0-beta  :done, 2021-04-06, 2021-07-06
        3.0.0-beta2 :done, 2021-07-06, 2021-09-15
        3.0.0-beta4 :done, 2021-09-15, 2021-10-12
        3.0.0-beta5 :done, 2021-10-12, 2022-01-12
        3.0.0       :done, 2022-01-12, 2022-05-04
        3.0.1       :done, 2022-05-04, 2022-09-14
        3.0.2-1     :done, 2022-09-14, 2023-04-12
        3.0.3       :done, 2023-04-12, 2024-01-01
    section 3.1 (STS)
        3.1.0-beta :done, 2023-06-19, 2023-07-26
        3.1.0-1    :done, 2023-07-26, 2023-08-09
        3.1.0-2    :done, 2023-08-09, 2023-12-20
        3.1.1      :done, 2023-12-20, 2024-09-27
        3.1.2      :done, 2024-09-27, 2025-02-25
        3.1.3      :done, 2025-02-25, 2025-04-01
    section 3.2 (LTS)
        3.2.0-beta1 :done,   2024-06-25, 2024-08-07
        3.2.0       :done,   2024-08-07, 2024-09-13
        3.2.0-2     :done,   2024-09-13, 2025-02-25
        3.2.1       :done,   2025-02-25, 2025-04-08
        3.2.1-1     :done,   2025-04-08, 2025-08-19
        3.2.2-1     :active, 2025-08-19, until today
        3.2.x       : after today, 2027-01-01

Loading

@jf-cbd
Copy link
Member

jf-cbd commented Sep 19, 2025

Hello @Hipska, thanks for updating our version history !

@jf-cbd jf-cbd merged commit 5d28de1 into Combodo:develop Sep 19, 2025
@github-project-automation github-project-automation bot moved this from First review needed to Finished in Combodo PRs dashboard Sep 19, 2025
@piRGoif
Copy link

piRGoif commented Sep 19, 2025

When creating this file I tried multiple Mermaid representations. We chose the git graph because it allow to view very clearly both version and date using the tags.

Maybe Gantt has evolved since then ? Does a tooltip shows when hovering the versions ?

@Hipska
Copy link
Contributor Author

Hipska commented Sep 19, 2025

See the example above. It doesn't in my browser.

Also, are these dates meant to represent the date of the tags? If so, almost none of them are correct..

@Hipska Hipska deleted the doc/version-history branch September 19, 2025 15:44
@piRGoif
Copy link

piRGoif commented Sep 19, 2025

Ok

About dates, I'm not sure ? I added the file back in 2022 with no PR (commit 9f0ac99 : wasn't easy to find because we lost history of the file with the latest delete / restore done manually :( ), and I don't think there are any documentation on this file ?

The idea was to replace both a document "on paper" and a spreadsheet, both internal but which main default was they were almost never in sync with the code.

I'm not sure but I think those were the internal build dates ?

@Hipska
Copy link
Contributor Author

Hipska commented Sep 22, 2025

@jf-cbd what do you (and the team) think about this representation? (see also the code how easy it is to write)

@piRGoif tooltip not yet supported.

@piRGoif
Copy link

piRGoif commented Sep 22, 2025

see also the code how easy it is to write

Indeed far much easier to understand and maintain !

The biggest flaw for me with that Gantt style representation is that it is made to show durations in time rather than milestones.

Well, it's up to the current team to decide what they need and what they want to communicate :) (hello to them by the way :) )

@jf-cbd
Copy link
Member

jf-cbd commented Sep 22, 2025

I'll ask the team about it (and say them hello from @piRGoif 😊) and keep you updated πŸ™‚

@jf-cbd
Copy link
Member

jf-cbd commented Sep 30, 2025

It turns out that Gantt schema doesn't seem to be appropriate to represent versions (example : 2.7.13 version that just got release)
Cf. conversation with @Hipska on Slack

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants