Skip to content

Add missing migration files for PRs #1153 and #1154 and remove Node.js 18 from CI templates#1157

Merged
Apollon77 merged 4 commits into
masterfrom
copilot/fix-1156
Aug 31, 2025
Merged

Add missing migration files for PRs #1153 and #1154 and remove Node.js 18 from CI templates#1157
Apollon77 merged 4 commits into
masterfrom
copilot/fix-1156

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Aug 31, 2025

This PR adds the missing migration documentation files for two recently merged PRs that made significant changes affecting adapter migration behavior, and completes the Node.js 18 removal by updating CI templates.

Background

PRs #1153 and #1154 introduced important changes to the adapter creator:

However, these PRs did not include the required migration documentation files in docs/updates/ that help users understand and apply these changes when migrating existing adapters. Additionally, the GitHub CI workflow templates still referenced Node.js 18.x.

Changes Made

1. Added 20250831_jsonconfig_schema_url_fix.md

Documents the jsonConfig schema URL change from the deprecated location in adapter-react-v5 to the official location in ioBroker.admin:

  • Old URL: https://raw.githubusercontent.com/ioBroker/adapter-react-v5/main/schemas/jsonConfig.json
  • New URL: https://raw.githubusercontent.com/ioBroker/ioBroker.admin/master/packages/jsonConfig/schemas/jsonConfig.json

Provides step-by-step instructions for updating .vscode/settings.json in existing adapters to use the correct schema for better IntelliSense and validation.

2. Added 20250831_remove_nodejs18_support.md

Documents the removal of Node.js 18 support and explains the automatic migration behavior:

  • Node.js 18 is no longer offered as an option for new adapters
  • Existing adapters using Node.js 18 are automatically upgraded to Node.js 20 during migration
  • Provides comprehensive manual migration steps for existing adapters including:
    • Updating package.json engines field
    • Updating Node.js type definitions
    • Updating TypeScript configuration base
    • Updating GitHub Actions workflows

3. Removed Node.js 18.x from GitHub CI Templates

Completed the Node.js 18 removal by removing 18.x from the adapterTestVersions array in the GitHub workflow template (templates/_github/workflows/test-and-release.yml.ts). This ensures newly created adapters will only test against Node.js 20.x and 22.x versions, fully aligning with the Node.js 18 support removal.

Migration Documentation Format

All files follow the established conventions:

  • Date-based filename format (YYYYMMDD_description.md)
  • Clear markdown structure with sections for "What changed", "How to update", and "Benefits"
  • Code examples with diff syntax for easy copying
  • Comprehensive step-by-step instructions

Verification

  • All existing tests continue to pass (101/101)
  • Migration files are properly formatted and accessible
  • Documentation is consistent with existing migration files in the repository
  • GitHub workflow templates updated to reflect Node.js 18 removal

Fixes #1156.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Co-authored-by: Apollon77 <11976694+Apollon77@users.noreply.github.com>
Copilot AI changed the title [WIP] Add missing migration files Add missing migration files for PRs #1153 and #1154 Aug 31, 2025
Copilot AI requested a review from Apollon77 August 31, 2025 17:21
@Apollon77
Copy link
Copy Markdown
Collaborator

@copilot Please do one additional change that was ,issed in the Node.js 18 removal PR: Please also remove 18.x from the Github CI template workflows

Remove 18.x from adapterTestVersions array in GitHub workflow template to complete Node.js 18 support removal.

Co-authored-by: Apollon77 <11976694+Apollon77@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Aug 31, 2025

@copilot Please do one additional change that was ,issed in the Node.js 18 removal PR: Please also remove 18.x from the Github CI template workflows

Done! Removed 18.x from the GitHub CI template workflows in commit b498c22. This completes the Node.js 18 removal by ensuring that newly created adapters will only test against Node.js 20.x and 22.x versions.

Copilot AI changed the title Add missing migration files for PRs #1153 and #1154 Add missing migration files for PRs #1153 and #1154 and remove Node.js 18 from CI templates Aug 31, 2025
@Apollon77 Apollon77 marked this pull request as ready for review August 31, 2025 18:37
@Apollon77 Apollon77 merged commit d1e308c into master Aug 31, 2025
5 checks passed
@Apollon77 Apollon77 deleted the copilot/fix-1156 branch August 31, 2025 18:43
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.

Add missing migration files

2 participants