MAINTAIN.md

Debug with VSCode

You can debug unit tests with VSCode following the steps: (Based on article)

1. Install VsCode
2. Install debugger-for-chrome extension.
3. Create launch.json file on ~/.vscode folder with follow config:

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "chrome",
      "request": "attach",
      "name": "Attach Karma Chrome",
      "address": "localhost",
      "port": 9333,
      "sourceMaps": true,
      "pathMapping": {
        "/": "${workspaceRoot}",
        "/base/": "${workspaceRoot}/"
      }
    }
  ]
}

4. On terminal, run test with command:

yarn test:debug

4. Open vscode
5. Set breakpoint on code
6. Press F5 to run Debug and wait to stop on breakpoint

Publish new version

1. develop to main

Send pull request develop to main on github repository and merge it. https://github.com/summernote/summernote/compare/main...develop

2. Build dist files

Build dist files and push to main

# change branch
git checkout main

# fetch all changes
git pull

# Bump version in package.json

# build dist files and binary(.zip) for release post
yarn build

# Commit and add tag for new version
git commit -a -m "Update dist files"
git tag -a "<new-version>"

# Push new dist files and tags to remote repository.
git push origin --tags

3. Release new version

Post release note with new tag version on github

https://github.com/summernote/summernote/releases/new

4. Publish

Publish on npm registry

yarn publish

5. Update summernote.github.io

Update summernote version in _config.yml.

6. Update connectors

Request maintainers of each connector to update package information.