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

Feature: [E606] Allow README.md without adapter version history #302

Open
Excodibur opened this issue Sep 27, 2024 · 4 comments
Open

Feature: [E606] Allow README.md without adapter version history #302

Excodibur opened this issue Sep 27, 2024 · 4 comments

Comments

@Excodibur
Copy link

It looks like E606 comes up, if there is no 3rd-level headline with the adapter vesion in the README.md (see https://github.com/ioBroker/ioBroker.repochecker/blob/7b0fa532daf771f2513cce74b84163f3f7f83048/lib/M600_Readme.js#L37C33-L37C36), which usually is only the case if the Adapter-Changelog is part of that main README.md. For adapters I maintain (tahoma, schwoerer-ventcube) I prefer to keep the Changelog in a separate file (CHANGELOG.md) which also has been supported by (release-script) for a very long time.

Please adjust the checker so that using a separate CHANGELOG-file for tracking adapter-versions is also supported.

@Apollon77
Copy link
Collaborator

No this will not work because the admin display expects that there are Changelog entries. The release script makes it that way that CHANGEOG.md contains full entries and in the main Readme only. the last 5 or such are listed. SO ideally some entries are in readme for the end user convenience

@Excodibur
Copy link
Author

Ok, let me check it. I assumed that the admin just takes the changelog entries from io-package.json.

@mcm1957
Copy link
Collaborator

mcm1957 commented Sep 27, 2024

@Apollon77
Are you sure?
At which place do you thinkbthat admin parses README?
Releasenotes at Installation Dialog are taken from io-package.json for sue as only this place contains transkates info.

The truncation at README done y releasescript relates to CHANGELOG_OÿLD.md

@Apollon77
Copy link
Collaborator

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

No branches or pull requests

3 participants