monaco-editor/MAINTAINING.md
2024-06-20 15:50:46 +02:00

3.6 KiB

Maintaining

(For maintainers only)

Make sure every unassigned issue is labeled properly:

Publishing a stable build monaco-editor build

  • Trigger an rc-build
  • Compare Last Stable With Nightly
    • Check the metadata and verify that the last stable is on the left and the the last rc build is on the right
  • Update package.json
    • set version to lastNightly.nextStableVersion (from the compare step)
    • set vscodeRef to lastNightly.vscodeCommitId
    • update devDependencies.monaco-editor-core to lastNightly.currentVersion
  • Run npm install to update lockfile
  • Update CHANGELOG.md
    • API Changes / Breaking Changes / New and noteworthy (use the diff from the compare step)
    • Add thank you mentions (use this tool and select only the monaco-editor)
  • Commit & Create PR
  • Trigger build once merged. Tick the following checkboxes:
    • Publish Monaco Editor Core
    • Publish Monaco Editor

Publish new webpack plugin

  • TBD
  • https://github.com/microsoft/monaco-editor/tree/main/webpack-plugin
  • npm install .
  • npm run import-editor
  • if there are no changes generated after the script:
    • update the peer dependency in package.json and use the || format e.g. "monaco-editor": "0.27.x || 0.28.x"
    • update the version matrix in the README.md and add the new editor version to the plugin's current major version
    • use npm version minor
    • publish using npm publish
  • if there are any changes generated after the script:
    • update the peer dependency in package.json e.g. "monaco-editor": "0.29.x"
    • update the version matrix in the README.md and add a new row with the new major version
    • use npm version major
    • publish using npm publish
  • remember to push tags upstream

Updating TypeScript

  • change typescript's version in package.json.
  • execute npm install .
  • execute npm run import-typescript
  • adopt new APIs