diff --git a/CHANGELOG.md b/CHANGELOG.md index 851b88fd4..8822b4438 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,9 @@ [Full changelog](https://github.com/mozilla/glean.js/compare/v1.1.0...main) +* [#1449](https://github.com/mozilla/glean.js/pull/1449): BUGFIX: Add missing quotes to `prepare-release` script to fix issues with version numbers in Qt sample README & circle ci config. +* [#1449](https://github.com/mozilla/glean.js/pull/1449): Update Qt sample project docs to include note about problems with different version numbers of Qt commands. + # v1.1.0 (2022-07-18) [Full changelog](https://github.com/mozilla/glean.js/compare/v1.0.0...v1.1.0) diff --git a/bin/prepare-release.sh b/bin/prepare-release.sh index eb033810c..391521ec7 100755 --- a/bin/prepare-release.sh +++ b/bin/prepare-release.sh @@ -142,13 +142,13 @@ run rm "${WORKSPACE_ROOT}/${FILE}.bak" FILE=samples/qt/README.md run $SED -i.bak -E \ - -e "s/--option platform=qt --option version=[0-9a-z.-]+/--option platform=qt --option version=\"${GLEAN_VERSION_FOR_QML}\"/" \ + -e "s/--option platform=qt --option version=\"[0-9a-z.-]+\"/--option platform=qt --option version=\"${GLEAN_VERSION_FOR_QML}\"/" \ "${WORKSPACE_ROOT}/${FILE}" run rm "${WORKSPACE_ROOT}/${FILE}.bak" FILE=.circleci/config.yml run $SED -i.bak -E \ - -e "s/--option platform=qt --option version=[0-9a-z.-]+/--option platform=qt --option version=\"${GLEAN_VERSION_FOR_QML}\"/" \ + -e "s/--option platform=qt --option version=\"[0-9a-z.-]+\"/--option platform=qt --option version=\"${GLEAN_VERSION_FOR_QML}\"/" \ "${WORKSPACE_ROOT}/${FILE}" run rm "${WORKSPACE_ROOT}/${FILE}.bak" diff --git a/samples/qt/README.md b/samples/qt/README.md index bb13a8a9e..4cf7be6b3 100644 --- a/samples/qt/README.md +++ b/samples/qt/README.md @@ -33,9 +33,11 @@ pip3 install -r requirements.txt # Install glean_parser 4. Generate metrics and pings files: +> **Note**: The version number below should match the last [released version](https://github.com/mozilla/glean.js/releases) number (minus the trailing `.0`). If the version numbers are different you will run into issues with QML code compilation. To resolve these errors you have to adjust the versions manually in the QML files + ```bash glean_parser translate src/App/metrics.yaml src/App/pings.yaml -f javascript -o src/App/generated \ ---option platform=qt --option version="0.31" +--option platform=qt --option version="1.1" ``` 5. Build the app: