mirror of
https://github.com/MichMich/MagicMirror.git
synced 2026-05-08 21:58:33 +00:00
d05ea751d9
## Release Notes Thanks to: @angeldeejay, @in-voker, @JHWelch, @khassel, @KristjanESPERANTO, @rejas, @sdetweil > ⚠️ This release needs nodejs version >=22.21.1 <23 || >=24 (no change to previous release) [Compare to previous Release v2.34.0](https://github.com/MagicMirrorOrg/MagicMirror/compare/v2.34.0...v2.25.0) > ⚠️ We introduced some internal changes with this release, please read [this forum post](https://forum.magicmirror.builders/topic/20138/upcoming-release-april-1-2026-breaking-changes-some-operational-changes) before upgrading! ### [core] - Prepare Release 2.35.0 (#4071) - docs: add security policy and vulnerability reporting guidelines (#4069) - refactor: simplify internal `require()` calls (#4056) - allow environment variables in cors urls (#4033) - fix cors proxy getting binary data (e.g. png, webp) (#4030) - fix: correct secret redaction and optimize loadConfig (#4031) - change loading config.js, allow variables in config.js and try to protect sensitive data (#4029) - remove kioskmode (#4027) - Add dark theme logo (#4026) - move custom.css from css to config (#4020) - move default modules from /modules/default to /defaultmodules (#4019) - update node versions in workflows (#4018) - [core] refactor: extract and centralize HTTP fetcher (#4016) - fix systeminformation not displaying electron version (#4012) - Update node-ical and support it's rrule-temporal changes (#4010) - Change default start scripts from X11 to Wayland (#4011) - refactor: unify favicon for index.html and Electron (#4006) - [core] run systeminformation in subprocess so the info is always displayed (#4002) - set next release dev number (#4000) ### [dependencies] - update dependencies (#4068) - update dependencies incl. electron to v41 (#4058) - chore: upgrade ESLint to v10 and fix newly surfaced issues (#4057) - chore: update ESLint and plugins, simplify config, apply new rules (#4052) - chore: update dependencies + add exports, files, and sideEffects fields to package.json (#4040) - [core] refactor: enable ESLint rule require-await and handle detected issues (#4038) - Update node-ical and other deps (#4025) - chore: update dependencies (#4021) - chore(eslint): migrate from eslint-plugin-vitest to @vitest/eslint-plugin and run rules only on test files (#4014) - Update deps as requested by dependabot (#4008) - update Collaboration.md and dependencies (#4001) ### [logging] - refactor: further logger clean-up (#4050) - Fix Node.js v25 logging prefix and modernize logger (#4049) ### [modules/calendar] - fix(calendar): make showEnd behavior more consistent across time formats (#4059) - test(calendar): fix hardcoded date in event shape test (#4055) - [calendar] refactor: delegate event expansion to node-ical's expandRecurringEvent (#4047) - calendar.js: remove useless hasCalendarURL function (#4028) - fix(calendar): update to node-ical 0.23.1 and fix full-day recurrence lookup (#4013) - fix(calendar): correct day-of-week for full-day recurring events across all timezones (#4004) ### [modules/newsfeed] - fix(newsfeed): fix full article view and add framing check (#4039) - [newsfeed] refactor: migrate to centralized HTTPFetcher (#4023) ### [modules/weather] - fix(weather): fix openmeteo forecast stuck in the past (#4064) - fix(weather): fix weathergov forecast day labels off by one (#4065) - weather: fixes for templates (#4054) - weather: add possibility to override njk's and css (#4051) - Use getDateString in openmeteo (#4046) - [weather] refactor: migrate to server-side providers with centralized HTTPFetcher (#4032) - [weather] feat: add Weather API Provider (#4036) ### [testing] - chore: remove obsolete Jest config and unit test global setup (#4044) - replace template_spec test with config_variables test (#4034) - refactor(clientonly): modernize code structure and add comprehensive tests (#4022) - Switch to undici Agent for HTTPS requests (#4015) - chore: migrate CI workflows to ubuntu-slim for faster startup times (#4007) --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Kristjan ESPERANTO <35647502+KristjanESPERANTO@users.noreply.github.com> Co-authored-by: Bugsounet - Cédric <github@bugsounet.fr> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: sam detweiler <sdetweil@gmail.com> Co-authored-by: Veeck <github@veeck.de> Co-authored-by: veeck <gitkraken@veeck.de> Co-authored-by: Magnus <34011212+MagMar94@users.noreply.github.com> Co-authored-by: Ikko Eltociear Ashimine <eltociear@gmail.com> Co-authored-by: DevIncomin <56730075+Developer-Incoming@users.noreply.github.com> Co-authored-by: Nathan <n8nyoung@gmail.com> Co-authored-by: mixasgr <mixasgr@users.noreply.github.com> Co-authored-by: Savvas Adamtziloglou <savvas-gr@greeklug.gr> Co-authored-by: Konstantinos <geraki@gmail.com> Co-authored-by: OWL4C <124401812+OWL4C@users.noreply.github.com> Co-authored-by: BugHaver <43462320+bughaver@users.noreply.github.com> Co-authored-by: BugHaver <43462320+lsaadeh@users.noreply.github.com> Co-authored-by: Koen Konst <koenspero@gmail.com> Co-authored-by: Koen Konst <c.h.konst@avisi.nl> Co-authored-by: dathbe <github@beffa.us> Co-authored-by: Marcel <m-idler@users.noreply.github.com> Co-authored-by: Kevin G. <crazylegstoo@gmail.com> Co-authored-by: Jboucly <33218155+jboucly@users.noreply.github.com> Co-authored-by: Jboucly <contact@jboucly.fr> Co-authored-by: Jarno <54169345+jarnoml@users.noreply.github.com> Co-authored-by: Jordan Welch <JordanHWelch@gmail.com> Co-authored-by: Blackspirits <blackspirits@gmail.com> Co-authored-by: Samed Ozdemir <samed@xsor.io> Co-authored-by: in-voker <58696565+in-voker@users.noreply.github.com> Co-authored-by: Andrés Vanegas Jiménez <142350+angeldeejay@users.noreply.github.com>
86 lines
4.1 KiB
Markdown
86 lines
4.1 KiB
Markdown
# Collaboration
|
|
|
|
This document describes how collaborators of this repository should work together.
|
|
|
|
## Pull Requests
|
|
|
|
- never merge your own PR's
|
|
- never merge without someone having approved (approving and merging from same person is allowed)
|
|
- wait for all approvals requested (or the author decides something different in the comments)
|
|
- merge to `master` only for releases or other urgent issues (update notification is only triggered by tags)
|
|
- merges to master should be tagged with the "mastermerge" label so that the test runs through
|
|
|
|
## Issues
|
|
|
|
- "real" Issues are closed if the problem is solved and the fix is released
|
|
- unrelated Issues (e.g. related to a foreign module) are closed immediately with a comment to open an issue in the module repository or to discuss this further in the forum or discord
|
|
|
|
## Releases
|
|
|
|
Are done by
|
|
|
|
- [ ] @rejas
|
|
- [ ] @sdetweil
|
|
- [ ] @khassel
|
|
- [ ] @KristjanESPERANTO
|
|
|
|
### Pre-Deployment steps
|
|
|
|
- [ ] update dependencies (a few days before)
|
|
|
|
### Deployment steps
|
|
|
|
- [ ] pull latest `develop` branch
|
|
- [ ] create `prep-release` branch from `develop`
|
|
- [ ] update `package.json` and `package-lock.json` to reflect correct version number `2.xx.0`
|
|
- [ ] test `prep-release` branch
|
|
- [ ] commit and push all changes
|
|
- [ ] create pull request from `prep-release` to `develop` branch with title `Prepare Release 2.xx.0`
|
|
- [ ] after successful test run via github actions: merge pull request to `develop`
|
|
- [ ] review the content of the automatically generated draft release named `unreleased`
|
|
- [ ] check contributor names
|
|
- [ ] check auto generated min. node version and adjust it for better readability if necessary
|
|
- [ ] check if all elements are assigned to the correct category
|
|
- [ ] change release name to `v2.xx.0`
|
|
- [ ] after successful test run via github actions: create pull request from `develop` to `master` branch
|
|
- [ ] add label `mastermerge`
|
|
- [ ] title of the PR is `Release 2.xx.0`
|
|
- [ ] description of the PR is the body of the draft release with name `v2.xx.0`
|
|
- [ ] check if new PR has merge conflicts, if so, merge `master` into the new PR and solve the conflicts
|
|
- [ ] after PR tests run without issues, merge PR
|
|
- [ ] edit draft release with name `v2.xx.0`
|
|
- [ ] set corresponding version tag `v2.xx.0` (with `Select tag` and then `Create new tag`)
|
|
- [ ] update release link in `Compare to previous Release` by replacing `develop` with new tag `v2.xx.0`
|
|
- [ ] publish the release (button at the bottom)
|
|
|
|
### Draft new development release
|
|
|
|
- [ ] checkout `develop` branch
|
|
- [ ] update `package.json` and `package-lock.json` to reflect correct version number `2.xx.0-develop`
|
|
- [ ] commit and push `develop` branch
|
|
- [ ] if new release will be in January, update the year in LICENSE.md
|
|
|
|
### After release
|
|
|
|
- [ ] publish release notes with link to github release on forum in new locked topic (use edit release on github to copy the content with markdown syntax)
|
|
- [ ] close all issues with label `ready (coming with next release)`
|
|
- [ ] release new documentation by merging `develop` on `master` in documentation repository
|
|
- [ ] publish new version on [npm](https://www.npmjs.com/package/magicmirror)
|
|
- [ ] use a clean environment (e.g. container)
|
|
- [ ] clone this repository with the new `master` branch and `cd` into the local repository directory
|
|
- [ ] **Method 1 (recommended): With browser and 2FA**
|
|
- [ ] execute `npm login` which will open a browser window
|
|
- [ ] log in with your npm credentials and enter your 2FA code
|
|
- [ ] execute `npm publish`
|
|
- [ ] **Method 2 (fallback for headless environments): With token (bypasses 2FA)**
|
|
- [ ] ⚠️ Note: This method bypasses 2FA and should only be used when a browser is not available
|
|
- [ ] goto `https://www.npmjs.com/settings/<username>/tokens/` and click `generate new token`
|
|
- [ ] enable `Bypass two-factor authentication (2FA)` and under `Packages and scopes` give `Read and write` permission to the `magicmirror` package, press `Generate token`
|
|
- [ ] execute:
|
|
|
|
```bash
|
|
NPM_TOKEN="npm_xxxxxx"
|
|
npm set "//registry.npmjs.org/:_authToken=$NPM_TOKEN"
|
|
npm publish
|
|
```
|