forked from microsoft/vscode-wiki
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add xtermjs instructions for automated update
- Loading branch information
1 parent
b28a527
commit de46240
Showing
1 changed file
with
25 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,7 +6,31 @@ Check out the [xterm.js contribution documentation](https://github.com/xtermjs/x | |
|
||
Since bugs and/or features manifest themselves in both VS Code and xterm.js, it's a little unclear initially where the issue(s) should be created. After some experimentation I landed on the best way to deal with this is to create the an issue in both the Microsoft/vscode and xtermjs/xterm.js repositories. The reason this is the best workflow is because the changes will then be verified during endgame and it's much easier to compose release notes for the terminal changes. This guideline is less important for more obscure terminal issues where it's typically easier to keep a single source of truth in the xterm.js repo. | ||
|
||
### Updating `xterm` in vscode | ||
### Updating `xterm` in vscode via script | ||
1. Copy `update-xterm.js` and `update-xterm.ps1` from [Daniel's dotfiles](https://github.com/Tyriar/dotfiles/tree/master/data/bin) into your vscode folder. Open a terminal on master and run `./update-xterm.ps1`. | ||
2. Add the changed files, excluding the aforementioned script files, and commit with the following message: | ||
|
||
``` | ||
[email protected] | ||
Diff: https://github.com/xtermjs/xterm.js/compare/91cbeec...eb25243 | ||
- Change 1... | ||
- Change 2... | ||
``` | ||
3. Build and run vscode to test terminal functionality. If all looks well, push. | ||
4. Open your vscode-distro folder and run: | ||
``` | ||
git pull | ||
git merge origin/oss/master | ||
``` | ||
|
||
4. Resolve any conflicts, being careful to remove unnecessary whitespace, and then push. | ||
5. Retrieve the commit hash via `git show` and open the vscode repo. | ||
6. Update the distro entry in `package.json` to the commit hash you copied, commit, and push. | ||
7. [Check](https://monacotools.visualstudio.com/Monaco/_build?definitionId=156&_a=summary) to confirm it builds. | ||
|
||
### Updating `xterm` in vscode manually | ||
|
||
Every commit that goes into the master branch of [xterm.js](https://github.com/xtermjs/xterm.js) is automatically released under the beta tag using Azure Pipelines. To update the module in vscode, follow these steps: | ||
|
||
|