Skip to content

Commit a5b5168

Browse files
committed
Bump version to 1.1.0 and add release notes for new features
1 parent 68958e4 commit a5b5168

File tree

3 files changed

+40
-21
lines changed

3 files changed

+40
-21
lines changed

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "edk2code",
33
"displayName": "Edk2code",
44
"description": "EDK2 code support",
5-
"version": "1.0.8",
5+
"version": "1.1.0",
66
"icon": "assets/icon.png",
77
"publisher": "intel-corporation",
88
"homepage": "https://github.com/intel/Edk2Code/wiki",

src/newVersionPage/1.1.0.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# EDK2Code new version
2+
3+
Thank you for installing the new version of the EDK2Code extension! 🎉
4+
5+
For detailed documentation, please visit: [EDK2Code Documentation](https://intel.github.io/Edk2Code/).
6+
7+
You can find our GitHub repository here: [EDK2Code GitHub Repository](https://github.com/intel/Edk2Code).
8+
9+
If you find this extension useful, please consider giving us a star on GitHub or leaving a review in the VSCode Marketplace. Your support is greatly appreciated! ⭐
10+
11+
# New features
12+
13+
## [Module map](https://intel.github.io/Edk2Code/advance_features/#module-map)
14+
15+
You can right click on a compiled INF file and select `EDK2: Show Module Map`
16+
17+
![module-map-context-menu](https://intel.github.io/Edk2Code/images/module-map-context-menu.png)
18+
19+
This will open the EDK2 submenu showing the libraries and source files that were used to compile that INF.
20+
21+
![module-map](https://intel.github.io/Edk2Code/images/module-map.png)
22+
23+
This feature is helpful in visualizing how a module includes various libraries. It also provides insights into how C files within the module include header files. By understanding these relationships, developers can better manage dependencies.
24+
25+
## [Error Detection](https://intel.github.io/Edk2Code/advance_features/#error-detection)
26+
27+
The DSC analysis can identify potential issues within the DSC files, such incorrect paths, duplicated libraries, etc. These issues are highlighted and shown in the Visual Studio Code "Problems" window.
28+
29+
![55e73504-3e8b-4b58-a9fa-5fc64a89614f](https://intel.github.io/Edk2Code/images/55e73504-3e8b-4b58-a9fa-5fc64a89614f.png)
30+
31+
You can disable this using the `edk2code.enableDiagnostics` setting
+8-20
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,18 @@
11
import { getCurrentVersion } from "../utils";
22
import * as vscode from 'vscode';
3-
3+
import * as path from 'path';
4+
import * as fs from 'fs';
45

56
export async function showReleaseNotes(context: vscode.ExtensionContext){
67
const CURRENT_VERSION = getCurrentVersion();
78
const previousVersion = context.globalState.get<string>('extensionVersion');
89
if (previousVersion !== CURRENT_VERSION) {
9-
const panel = vscode.window.createWebviewPanel(
10-
'releaseNotes',
11-
`EDK2Code Release Notes ${CURRENT_VERSION}`,
12-
vscode.ViewColumn.One,
13-
{
14-
enableScripts: true,
15-
}
16-
);
17-
18-
panel.webview.html = `
19-
<h1>Edk2Code <strong>${CURRENT_VERSION}</strong></h1>
20-
<p>Thanks for using the <strong>Edk2Code Vscode extension</strong>.</p>
21-
<p>🎉 If you find this extension useful 🎉:</p>
22-
<ul>
23-
<li>⭐ Give a start on <a href="https://github.com/intel/Edk2Code">Github</a></li>
24-
<li>📜 Leave a review in <a href="https://marketplace.visualstudio.com/items?itemName=intel-corporation.edk2code">Vscode marketplace</a></li>
25-
</ul>
26-
<h2><a href="https://intel.github.io/Edk2Code/releases/${CURRENT_VERSION}/">View new features</a></h2>
27-
`;
2810
await context.globalState.update('extensionVersion', CURRENT_VERSION);
11+
12+
const releaseNotesPath = path.join(context.extensionPath, 'src', 'newVersionPage', `${CURRENT_VERSION}.md`);
13+
if (fs.existsSync(releaseNotesPath)) {
14+
const releaseNotesUri = vscode.Uri.file(releaseNotesPath);
15+
await vscode.commands.executeCommand('markdown.showPreview', releaseNotesUri);
16+
}
2917
}
3018
}

0 commit comments

Comments
 (0)