#1748: improve IDEasy status documentation#1897
Conversation
…#1748-improve-status-doc
Coverage Report for CI Build 25716448412Coverage increased (+0.05%) to 70.673%Details
Uncovered ChangesNo uncovered changes found. Coverage RegressionsNo coverage regressions found. Coverage Stats💛 - Coveralls |
…#1748-improve-status-doc
…changelog, improve code quality
…changelog, improve code quality
…MarvMa/IDEasy into feature/devonfw#1748-improve-status-doc
jakozian
left a comment
There was a problem hiding this comment.
Very nice looking quality-status documentation!
There was a problem hiding this comment.
Looks very good! I’ve taken a look at it now and everything looked great.
Are there already ideas on when this should be executed?
I’m thinking of an action that runs either as part of the nightly build or on every PR build, so that the file is always up to date.
I suppose it makes sense to run this every release to balance resource overhead and actuality |
Removed outdated information about OS support and developer team recommendations.
hohwille
left a comment
There was a problem hiding this comment.
@MarvMa thanks for your PR. Great job to generate this with some python magic... 👍
When we update the report, this can be merged.
I would however, prefer to have also a workflow to regenerate with a click (and at least once per month or week automatically).
| @@ -0,0 +1,1468 @@ | |||
| = IDEasy Quality Status | |||
There was a problem hiding this comment.
very nice. I especially like the emoji/Unicode-icons and the overview.
Maybe should generate separate docs per OS and link them from the Readme per OS with according OS icon/emoji? I fear that 99% of the users never make it below the initial table that lists the overall issues that is currently quite long...
I found lots of issues in this list that have been fixed already but were never closed.
I updated and closed them on GitHub so we should rerun your tool to get a fresh list.
I like this idea very much but I will not be able to rerun the status script frequently and therefore have doubts that anybody else will ever do.
If we want to go for this approach we have to integrate it as a GHA workflow.
In the end we could do the same thing with GitHub issue queries.
Currently this report also mixes severe bugs (tool xyz cannot even be installed on Mac) with totally irrelevant edge-case issues (e.g. auto-completion is not perfect).
Therefore I cannot easily see if I really have big problems on my OS.
I could also go to the issue tracker and filter by the desired OS label to get the same list of many issues listed but would need to go through all of them to get a real impression if IDEasy works fine or catastrophic on that OS.
Could we do the same somehow with something like iframes in adoc or md file?
Is it also possible to get additional metadata from the issues like priority? This could really make a difference if we distinguish by that and maybe even ignore Low prio issues and rank Urgent issues accordingly...
Great that you already make use of the Blocker issue.
This PR fixes #1748
Implemented changes:
quality-status.adocfilequality-status.adocis beeing referenced in the readme.md and contains an overview with all the open issues for each os with a classification for blocker, bugs or features.Checklist for this PR
Make sure everything is checked before merging this PR. For further info please also see
our DoD.
mvn clean testlocally all tests pass and build is successful#«issue-id»: «brief summary»(e.g.#921: fixed setup.bat). If no issue ID exists, title only.In Progressand assigned to you or there is no issue (might happen for very small PRs)with
internal