Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] README indicates the lowest supported TypeScript version #2251

Merged
merged 3 commits into from
Sep 16, 2022

Conversation

tbouffard
Copy link
Member

Put the information in the README. This is a first step of larger changes that will be implemented later.
Making it explicit in the README is just a minimum.

refs #2246

@tbouffard tbouffard added the documentation Improvements or additions to documentation label Sep 16, 2022
@tbouffard tbouffard changed the title [DOC] Document the lowest TS version needed by bpmn-visualization [DOC] README states the lowest TS version needed by bpmn-visualization Sep 16, 2022
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@tbouffard tbouffard requested a review from assynour September 16, 2022 06:38
Copy link
Contributor

@assynour assynour left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From what I understood in #2246, it is TS 4.5 for 0.26.1. This does not apply for older releases, right? should we explicitly mention something like "starting from 0.26.1..."?

@tbouffard
Copy link
Member Author

tbouffard commented Sep 16, 2022

From what I understood in #2246, it is TS 4.5 for 0.26.1. This does not apply for older releases, right? should we explicitly mention something like "starting from 0.26.1..."?

The README is always about the latest version.
That being said, I can add a note about the latest bpmn-visualization version that support previous TypeScript version. That can be helpful until we implement #2252
In #2246, I have notice that TS 4.5 has been required since v0.21.0. In #2221, a user mention they have to use v0.20.0 with Angular 11 which doesn't support TS 4.5.

I am going to do some tests in the example repository to confirm it

@tbouffard
Copy link
Member Author

@assynour previous versions could run with older TypeScript version but the types have major issues that we fixed in https://github.com/process-analytics/bpmn-visualization-js/releases/tag/v0.21.5.
For instance, I can use TypeScript 4.1.6 with bpmn-visualization 0.19.5, but I got plenty of errors that are fixed by #1814.
And I don't know what TS version older versions can be run with.

For all these reasons, I don't want to add more information in the README and I suggest we keep only valid information for the current release.

@tbouffard tbouffard changed the title [DOC] README states the lowest TS version needed by bpmn-visualization [DOC] README indicates the lowest supported TypeScript version Sep 16, 2022
@tbouffard tbouffard merged commit 7da25c6 into master Sep 16, 2022
@tbouffard tbouffard deleted the doc/ts_min_version branch September 16, 2022 15:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants