Release Init VS Code Extension
Description: A VS Code extension to help automate release-related tasks (currently runs a predefined script).
Features
- Run Script Button: Adds a
$(play) Run Script button to the VS Code status bar (bottom left).
- Script Execution: Clicking the button executes a predefined script (currently set to
git status) within the root of your opened workspace folder.
- Output Channel: Displays the standard output and standard error of the executed script in a dedicated output channel named "Release Init Script".
- Status Notifications: Shows an information message on successful script completion or an error message if the script fails.
- Status Bar Updates: The status bar button icon changes to indicate the script's status (running, success, error).
Usage
- Ensure you have a project/folder open in VS Code.
- Click the
$(play) Run Script button located in the status bar.
- Observe the output in the "Release Init Script" output channel (View -> Output, then select "Release Init Script" from the dropdown).
- A notification will appear indicating the success or failure of the script.
Development
- Build:
yarn run compile or npm run compile
- Watch:
yarn run watch or npm run watch
- Run in Extension Host: Press
F5
Customization
Currently, the script to be executed (git status) is hardcoded in src/extension.ts. Future versions could make this configurable through VS Code settings.
Requirements
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
Extension Settings
Include if your extension adds any VS Code settings through the contributes.configuration extension point.
For example:
This extension contributes the following settings:
myExtension.enable: Enable/disable this extension.myExtension.thing: Set to blah to do something.
Known Issues
Calling out known issues can help limit users opening duplicate issues against your extension.
Release Notes
Users appreciate release notes as you update your extension.
1.0.0
Initial release of ...
1.0.1
Fixed issue #.
1.1.0
Added features X, Y, and Z.
Following extension guidelines
Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
Working with Markdown
You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
- Split the editor (
Cmd+\ on macOS or Ctrl+\ on Windows and Linux).
- Toggle preview (
Shift+Cmd+V on macOS or Shift+Ctrl+V on Windows and Linux).
- Press
Ctrl+Space (Windows, Linux, macOS) to see a list of Markdown snippets.
Enjoy!
