diff --git a/v3/CHANGELOG.md b/v3/CHANGELOG.md new file mode 100644 index 000000000..88691548f --- /dev/null +++ b/v3/CHANGELOG.md @@ -0,0 +1,30 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +- `Added` for new features. +- `Changed` for changes in existing functionality. +- `Deprecated` for soon-to-be removed features. +- `Removed` for now removed features. +- `Fixed` for any bug fixes. +- `Security` in case of vulnerabilities. + +## [Unreleased] + +### Fixed + +- Fixed background colours of examples on Windows by [mmgvh](https://github.com/mmghv) in [#2750](https://github.com/wailsapp/wails/pull/2750). +- Fixed default context menus by [mmgvh](https://github.com/mmghv) in [#2753](https://github.com/wailsapp/wails/pull/2753). + +### Changed + +### Added +* [darwin] add getPrimaryScreen/getScreens to impl by @tmclane in https://github.com/wailsapp/wails/pull/2618 + +### Removed + +## What's Changed + diff --git a/v3/DEVELOPMENT.md b/v3/DEVELOPMENT.md index 95fe29cfd..ec854377e 100644 --- a/v3/DEVELOPMENT.md +++ b/v3/DEVELOPMENT.md @@ -139,3 +139,35 @@ wails3 task cli:install wails3 task -version ``` +## Opening a PR + +Make sure that all PRs have a ticket associated with them providing context to the change. If there is no ticket, please create one first. +Ensure that all PRs have updated the CHANGELOG.md file with the changes made. The CHANGELOG.md file is located in the `v3` directory. + + +## Misc Tasks + +### Upgrading Taskfile + +The Wails CLI uses the [Task](https://taskfile.dev) build system. It is imported as a library and used to run the tasks defined in `Taskfile.yaml`. +The main interfacing with Task happens in `v3/internal/commands/task.go`. + +To check if there's an upgrade for Taskfile, run `wails3 task -version` and check against the Task website. + +To upgrade the version of Taskfile used, run: + +```shell +wails3 task taskfile:upgrade +``` + +If there are incompatibilities then they should appear in the `v3/internal/commands/task.go` file. + +Usually the best way to fix incompatibilities is to clone the task repo at `https://github.com/go-task/task` and look at the git history to determine what has changed and why. + +To check all changes have worked correctly, re-install the CLI and check the version again: + +```shell +wails3 task cli:install +wails3 task -version +``` +