From 20ee5139d6bb3437f79bf1b3a784653458ecd72a Mon Sep 17 00:00:00 2001 From: a1mery <7100077+a1mery@users.noreply.github.com> Date: Thu, 3 Oct 2024 23:01:35 +0200 Subject: [PATCH] update README --- samples/js-advanced-commenting/README.md | 1 + .../js-advanced-commenting/upgrade-report.md | 291 ------------------ 2 files changed, 1 insertion(+), 291 deletions(-) delete mode 100644 samples/js-advanced-commenting/upgrade-report.md diff --git a/samples/js-advanced-commenting/README.md b/samples/js-advanced-commenting/README.md index 8acfefd7c..a63ca322c 100644 --- a/samples/js-advanced-commenting/README.md +++ b/samples/js-advanced-commenting/README.md @@ -85,6 +85,7 @@ Version|Date|Comments 1.2.0.0|March 09, 2023|Upgraded to 1.16.1 1.3.0.0|June 10, 2023|Upgraded to 1.17.0 1.3.0.1|March 11, 2024|`this.pageurl` must be initialized before building `this.pastAtachmentPath` +1.4.0.0|October 03, 2024|Upgraded to 1.30.0 ## Minimal Path to Awesome diff --git a/samples/js-advanced-commenting/upgrade-report.md b/samples/js-advanced-commenting/upgrade-report.md deleted file mode 100644 index d6c594b5f..000000000 --- a/samples/js-advanced-commenting/upgrade-report.md +++ /dev/null @@ -1,291 +0,0 @@ -# Upgrade project Advanced Comments Box to v1.20.0 - -Date: 10/3/2024 - -## Findings - -Following is the list of steps required to upgrade your project to SharePoint Framework version 1.20.0. [Summary](#Summary) of the modifications is included at the end of the report. - -### FN001001 @microsoft/sp-core-library | Required - -Upgrade SharePoint Framework dependency package @microsoft/sp-core-library - -Execute the following command: - -```sh -npm i -SE @microsoft/sp-core-library@1.20.0 -``` - -File: [./package.json:13:5](./package.json) - -### FN001002 @microsoft/sp-lodash-subset | Required - -Upgrade SharePoint Framework dependency package @microsoft/sp-lodash-subset - -Execute the following command: - -```sh -npm i -SE @microsoft/sp-lodash-subset@1.20.0 -``` - -File: [./package.json:14:5](./package.json) - -### FN001003 @microsoft/sp-office-ui-fabric-core | Required - -Upgrade SharePoint Framework dependency package @microsoft/sp-office-ui-fabric-core - -Execute the following command: - -```sh -npm i -SE @microsoft/sp-office-ui-fabric-core@1.20.0 -``` - -File: [./package.json:15:5](./package.json) - -### FN001004 @microsoft/sp-webpart-base | Required - -Upgrade SharePoint Framework dependency package @microsoft/sp-webpart-base - -Execute the following command: - -```sh -npm i -SE @microsoft/sp-webpart-base@1.20.0 -``` - -File: [./package.json:17:5](./package.json) - -### FN001021 @microsoft/sp-property-pane | Required - -Upgrade SharePoint Framework dependency package @microsoft/sp-property-pane - -Execute the following command: - -```sh -npm i -SE @microsoft/sp-property-pane@1.20.0 -``` - -File: [./package.json:16:5](./package.json) - -### FN001034 @microsoft/sp-adaptive-card-extension-base | Optional - -Upgrade SharePoint Framework dependency package @microsoft/sp-adaptive-card-extension-base - -Execute the following command: - -```sh -npm i -SE @microsoft/sp-adaptive-card-extension-base@1.20.0 -``` - -File: [./package.json:12:5](./package.json) - -### FN002001 @microsoft/sp-build-web | Required - -Upgrade SharePoint Framework dev dependency package @microsoft/sp-build-web - -Execute the following command: - -```sh -npm i -DE @microsoft/sp-build-web@1.20.2 -``` - -File: [./package.json:33:5](./package.json) - -### FN002002 @microsoft/sp-module-interfaces | Required - -Upgrade SharePoint Framework dev dependency package @microsoft/sp-module-interfaces - -Execute the following command: - -```sh -npm i -DE @microsoft/sp-module-interfaces@1.20.2 -``` - -File: [./package.json:34:5](./package.json) - -### FN002021 @rushstack/eslint-config | Required - -Upgrade SharePoint Framework dev dependency package @rushstack/eslint-config - -Execute the following command: - -```sh -npm i -DE @rushstack/eslint-config@4.0.1 -``` - -File: [./package.json:35:5](./package.json) - -### FN002024 eslint | Required - -Upgrade SharePoint Framework dev dependency package eslint - -Execute the following command: - -```sh -npm i -DE eslint@8.57.0 -``` - -File: [./package.json:40:5](./package.json) - -### FN002022 @microsoft/eslint-plugin-spfx | Required - -Upgrade SharePoint Framework dev dependency package @microsoft/eslint-plugin-spfx - -Execute the following command: - -```sh -npm i -DE @microsoft/eslint-plugin-spfx@1.20.2 -``` - -File: [./package.json:30:5](./package.json) - -### FN002023 @microsoft/eslint-config-spfx | Required - -Upgrade SharePoint Framework dev dependency package @microsoft/eslint-config-spfx - -Execute the following command: - -```sh -npm i -DE @microsoft/eslint-config-spfx@1.20.2 -``` - -File: [./package.json:29:5](./package.json) - -### FN010001 .yo-rc.json version | Recommended - -Update version in .yo-rc.json - -```json -{ - "@microsoft/generator-sharepoint": { - "version": "1.20.0" - } -} -``` - -File: [./.yo-rc.json:5:5](./.yo-rc.json) - -### FN010010 .yo-rc.json @microsoft/teams-js SDK version | Recommended - -Update @microsoft/teams-js SDK version in .yo-rc.json - -```json -{ - "@microsoft/generator-sharepoint": { - "sdkVersions": { - "@microsoft/teams-js": "2.24.0" - } - } -} -``` - -File: [./.yo-rc.json:14:7](./.yo-rc.json) - -### FN001035 @fluentui/react | Required - -Install SharePoint Framework dependency package @fluentui/react - -Execute the following command: - -```sh -npm i -SE @fluentui/react@8.106.4 -``` - -File: [./package.json:11:3](./package.json) - -### FN002026 typescript | Required - -Upgrade SharePoint Framework dev dependency package typescript - -Execute the following command: - -```sh -npm i -DE typescript@4.7.4 -``` - -File: [./package.json:42:5](./package.json) - -### FN002028 @microsoft/rush-stack-compiler-4.7 | Required - -Install SharePoint Framework dev dependency package @microsoft/rush-stack-compiler-4.7 - -Execute the following command: - -```sh -npm i -DE @microsoft/rush-stack-compiler-4.7@0.1.0 -``` - -File: [./package.json:28:3](./package.json) - -### FN021003 package.json engines.node | Required - -Update package.json engines.node property - -```json -{ - "engines": { - "node": ">=16.13.0 <17.0.0 || >=18.17.1 <19.0.0" - } -} -``` - -File: [./package.json:45:5](./package.json) - -### FN017001 Run npm dedupe | Optional - -If, after upgrading npm packages, when building the project you have errors similar to: "error TS2345: Argument of type 'SPHttpClientConfiguration' is not assignable to parameter of type 'SPHttpClientConfiguration'", try running 'npm dedupe' to cleanup npm packages. - -Execute the following command: - -```sh -npm dedupe -``` - -File: [./package.json](./package.json) - -## Summary - -### Execute script - -```sh -npm i -SE @microsoft/sp-core-library@1.20.0 @microsoft/sp-lodash-subset@1.20.0 @microsoft/sp-office-ui-fabric-core@1.20.0 @microsoft/sp-webpart-base@1.20.0 @microsoft/sp-property-pane@1.20.0 @microsoft/sp-adaptive-card-extension-base@1.20.0 @fluentui/react@8.106.4 -npm i -DE @microsoft/sp-build-web@1.20.2 @microsoft/sp-module-interfaces@1.20.2 @rushstack/eslint-config@4.0.1 eslint@8.57.0 @microsoft/eslint-plugin-spfx@1.20.2 @microsoft/eslint-config-spfx@1.20.2 typescript@4.7.4 @microsoft/rush-stack-compiler-4.7@0.1.0 -npm dedupe -``` - -### Modify files - -#### [./.yo-rc.json](./.yo-rc.json) - -Update version in .yo-rc.json: - -```json -{ - "@microsoft/generator-sharepoint": { - "version": "1.20.0" - } -} -``` - -Update @microsoft/teams-js SDK version in .yo-rc.json: - -```json -{ - "@microsoft/generator-sharepoint": { - "sdkVersions": { - "@microsoft/teams-js": "2.24.0" - } - } -} -``` - -#### [./package.json](./package.json) - -Update package.json engines.node property: - -```json -{ - "engines": { - "node": ">=16.13.0 <17.0.0 || >=18.17.1 <19.0.0" - } -} -```