fix: marketplace README #4639

Author: hayemaxi

.github/workflows/release.yml

@@ -52,7 +52,6 @@ jobs:
             - name: vsix # TODO: For packages/toolkit release only
               run: |
                   npm run createRelease  # Generate CHANGELOG.md
-                  cp ./README.quickstart.vscode.md ./README.md
                   npm run -w packages/toolkit package -- --feature "$FEAT_NAME"
             - uses: actions/upload-artifact@v4
               with:

.gitignore

@@ -10,8 +10,6 @@ coverage
 .idea
 telemetryCache
 quickStart*.html
-README.quickstart.cloud9.md
-README.quickstart.vscode.md
 .gitcommit
 __pycache__
 
@@ -39,7 +37,6 @@ packages/core/src/testFixtures/**/bin
 packages/core/src/testFixtures/**/obj
 
 # Generated by copyFiles.ts
-packages/*/README*
 packages/*/CHANGELOG.md
 packages/*/LICENSE
 packages/*/NOTICE

CONTRIBUTING.md

@@ -252,8 +252,6 @@ Pull requests that change **customer-impacting behavior** must include a changel
 
     npm run newChange
 
-
-
 > [!TIP]
 >
 > -   Describe the change in a way that is _meaningful to the customer_. If you can't describe the _customer impact_ then it probably shouldn't be in the changelog.
@@ -270,7 +268,6 @@ Pull requests that change **customer-impacting behavior** must include a changel
 > -   If there are multiple unrelated changes, run `npm run newChange` for each change.
 > -   Include the feature that the change affects, Q, CodeWhisperer, etc.
 
-
 ### Commit messages
 
 Generally your PR description should be a copy-paste of your commit message(s).
@@ -539,8 +536,7 @@ As a simple example, let's say I wanted to add a new icon for CloudWatch log str
 ### VSCode Marketplace
 
 The [marketplace page](https://marketplace.visualstudio.com/itemdetails?itemName=AmazonWebServices.aws-toolkit-vscode)
-is defined in `README.quickstart.vscode.md` (which replaces `README.md` during
-the release automation). The `vsce` package tool always [replaces relative image paths](https://github.com/microsoft/vscode-vsce/blob/9478dbd11ea2e7adb23ec72923e889c7bb215263/src/package.ts#L885)
+is defined in `packages/toolkit/README.md`. The `vsce` package tool always [replaces relative image paths](https://github.com/microsoft/vscode-vsce/blob/9478dbd11ea2e7adb23ec72923e889c7bb215263/src/package.ts#L885)
 with URLs pointing to `HEAD` on GitHub (`https://github.com/aws/aws-toolkit-vscode/raw/HEAD/…/foo.gif`).
 
 Note therefore:

buildspec/packageTestVsix.yml

@@ -27,7 +27,6 @@ phases:
             - export HOME=/home/codebuild-user
             # Generate CHANGELOG.md
             - npm run createRelease
-            - cp ./README.quickstart.vscode.md ./README.md
             - npm run package
 
 artifacts:

buildspec/release/20buildrelease.yml

@@ -21,7 +21,6 @@ phases:
         commands:
             # --unsafe-perm is needed because we run as root
             - npm ci --unsafe-perm
-            - cp ./README.quickstart.vscode.md ./README.md
             - npm run package
 
 artifacts:

README.quickstart.vscode.md renamed to packages/toolkit/README.md

@@ -59,7 +59,7 @@
         "buildScripts": "npm run generateNonCodeFiles && npm run copyFiles",
         "generateNonCodeFiles": "ts-node ./scripts/build/generateNonCodeFiles.ts",
         "copyFiles": "ts-node ./scripts/build/copyFiles.ts",
-        "clean": "ts-node ../../scripts/clean.ts dist/ LICENSE NOTICE quickStart* README* CHANGELOG.md",
+        "clean": "ts-node ../../scripts/clean.ts dist/ LICENSE NOTICE quickStart* CHANGELOG.md",
         "compile": "npm run clean && npm run buildScripts && webpack --mode development",
         "webWatch": "npm run clean && npm run copyFiles --vueHr && webpack --config-name web --watch",
         "webCompile": "npm run clean && npm run buildScripts -- --vueHr && webpack --config-name web",

README.quickstart.cloud9.md renamed to packages/toolkit/README.quickstart.cloud9.md

@@ -29,17 +29,7 @@ interface CopyTask {
 }
 
 const tasks: CopyTask[] = [
-    ...[
-        'CHANGELOG.md',
-        'LICENSE',
-        'NOTICE',
-        'README.md',
-        'README.quickstart.cloud9.md',
-        'README.quickstart.vscode.md',
-        'quickStartCloud9-cn.html',
-        'quickStartCloud9.html',
-        'quickStartVscode.html',
-    ].map(f => {
+    ...['CHANGELOG.md', 'LICENSE', 'NOTICE'].map(f => {
         return { target: path.join('../../', f), destination: path.join(projectRoot, f) }
     }),
 

packages/toolkit/package.json

@@ -9,7 +9,7 @@ import { marked } from 'marked'
 import * as path from 'path'
 
 // doesn't use path utils as this should be formatted for finding images with HTML markup
-const repoRoot = path.join(process.cwd(), '../../') // root/packages/toolkit -> root/
+const projectRoot = process.cwd()
 
 /**
  * replaces relative paths with an `!!EXTENSIONROOT!!` token.
@@ -47,10 +47,10 @@ function generateFileHash(root: string) {
 }
 
 try {
-    translateReadmeToHtml(repoRoot, 'README.quickstart.vscode.md', 'quickStartVscode.html')
-    translateReadmeToHtml(repoRoot, 'README.quickstart.cloud9.md', 'quickStartCloud9.html')
-    translateReadmeToHtml(repoRoot, 'README.quickstart.cloud9.md', 'quickStartCloud9-cn.html', true)
-    generateFileHash(repoRoot)
+    translateReadmeToHtml(projectRoot, 'README.md', 'quickStartVscode.html')
+    translateReadmeToHtml(projectRoot, 'README.quickstart.cloud9.md', 'quickStartCloud9.html')
+    translateReadmeToHtml(projectRoot, 'README.quickstart.cloud9.md', 'quickStartCloud9-cn.html', true)
+    generateFileHash(projectRoot)
 } catch (error) {
     console.error(error)
     process.exit(100)