Skip to content

Re-enable README.md and LICENSE validation checks - #694

Merged
Apollon77 merged 3 commits into
masterfrom
copilot/reenable-readme-license-check
Nov 8, 2025
Merged

Apollon77 merged 3 commits into
masterfrom
copilot/reenable-readme-license-check

Conversation

Copilot AI commented Nov 8, 2025 •

Copy link
Copy Markdown
Contributor

Re-enable README.md and LICENSE file checks

Plan:

  • Explore repository and understand the issue
  • Uncomment the existing checks for README.md and LICENSE files
  • Verify the code formatting matches the existing style
  • Run linting to ensure code quality
  • Build the project to ensure TypeScript compiles correctly
  • Run tests to ensure no regressions
  • Manually test with test adapter scenarios
  • Run code review to validate changes
  • Run security check with CodeQL
  • Add changelog entry for the changes
  • Enhance copilot instructions to include changelog requirements

Changes Made:

  1. Uncommented the Check additional files test suite
  2. Updated code style to match project standards (single quotes, proper indentation)
  3. Fixed linting issue by adding curly braces to if statement
  4. Added changelog entry documenting the re-enabled validation checks
  5. Enhanced .github/copilot-instructions.md with changelog guidelines

Changelog Entry Added:

* (@Apollon77/@copilot) Re-enabled validation checks for README.md and LICENSE files in packageFiles tests

Testing:

Manually tested all scenarios:

  • ✅ Both README.md and LICENSE exist - tests pass
  • ✅ README.md missing - test fails with appropriate error
  • ✅ LICENSE missing and not in README.md - test fails with appropriate error
  • ✅ LICENSE missing but section exists in README.md - test passes

Validation:

  • ✅ Linting passed (npm run lint)
  • ✅ Build passed (npm run build)
  • ✅ Tests passed (npm test)
  • ✅ Manual testing completed
  • ✅ CodeQL security scan: No issues found

Security Summary:

No security vulnerabilities were introduced by these changes. CodeQL analysis found 0 alerts.

These checks ensure every ioBroker adapter has proper documentation and licensing information, which is essential for open source projects.

Original prompt

This section details on the original issue you should resolve

<issue_title>Reenable existing check for README.md and LICENSE files</issue_title>
<issue_description>Consider reenabling check for README.d and LICENSE

// describe(`Check additional files`, () => {

Every Adapter should have those files. I do not see why this check has been removed sometime in the past. Please consider readding or drop a note why this is not desired.

</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: Apollon77 <11976694+Apollon77@users.noreply.github.com>
Copilot AI changed the title [WIP] Reenable check for README.md and LICENSE files Re-enable README.md and LICENSE validation checks Nov 8, 2025
Copilot AI requested a review from Apollon77 November 8, 2025 13:37

@Apollon77 Apollon77 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@copilot Please add a changelog entry, also enhance your copilot instructions file to not forget this

@Apollon77
Apollon77 marked this pull request as ready for review November 8, 2025 13:40
@Apollon77

Copy link
Copy Markdown
Collaborator

@copilot add a changelog entry, also enhance your copilot instructions file to not forget this

…quirements

Co-authored-by: Apollon77 <11976694+Apollon77@users.noreply.github.com>

Copilot AI commented Nov 8, 2025 •

Copy link
Copy Markdown
Contributor Author

@copilot add a changelog entry, also enhance your copilot instructions file to not forget this

Completed in commit 61fa41c. Added changelog entry under "WORK IN PROGRESS" section and enhanced .github/copilot-instructions.md with comprehensive changelog guidelines.

@copilot Please add a changelog entry, also enhance your copilot instructions file to not forget this

Added changelog entry and enhanced copilot instructions in commit 61fa41c.

The changelog now includes:

  • Entry for the re-enabled README.md and LICENSE validation checks

The copilot instructions now include:

  • Changelog guidelines section with required format and examples
  • Reminder to always add changelog entries for user-facing changes

Copilot AI requested a review from Apollon77 November 8, 2025 13:50
@Apollon77
Apollon77 merged commit 19255cf into master Nov 8, 2025
11 of 13 checks passed
@Apollon77
Apollon77 deleted the copilot/reenable-readme-license-check branch November 8, 2025 14:38
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.

Reenable existing check for README.md and LICENSE files

2 participants