Skip to content
This repository has been archived by the owner on Dec 9, 2023. It is now read-only.

Commit

Permalink
Merge pull request #431 from edtr-io/fix/post-release-fixes
Browse files Browse the repository at this point in the history
Fix/post release fixes
  • Loading branch information
hejtful committed Mar 30, 2023
2 parents dfd5d28 + 7945d28 commit 7b40bce
Show file tree
Hide file tree
Showing 33 changed files with 221 additions and 209 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

All notable changes to this project will be documented in this file.

## [v3.0.2](https://github.com/edtr-io/edtr-io/compare/v3.0.1..v3.0.2) - March 30, 2023

### Changed

- **plugin-text**. Move window.getSelection call inside of component

- **plugin-text**. Use list-item-child instead of list-item-text

## [v3.0.1](https://github.com/edtr-io/edtr-io/compare/v3.0.0..v3.0.1) - March 29, 2023

### Changed
Expand Down
14 changes: 6 additions & 8 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,15 @@
1. `git checkout main` - switch to `main` branch
2. `git pull` - update the `main` branch
3. `yarn build` - run it locally to check if the build will pass
4. `yarn regenerate-api` - run it locally to check if the generated API documentation is up to date
4. `git checkout -b release-vX.X.X` - create and switch to the release branch
5. `yarn prepare-release` - updates the Lerna version (which will be read by the GitHub deploy workflow (`/.github/workflows/deploy.yml`) once the release commit is pushed)
6. Add a changelog entry in `/scripts/changelog.ts`
7. `yarn changelog` - to generate a new changelog entry in `CHANGELOG.md`
8. `git commit -m "release X.X.X"` - commit the changes with the correct release version

> This either increases the version number of all packages to the same number or only increase the version number of those packages that were changed. Still not entirely clear.
9. Push your changes, and a [deploy workflow](https://github.com/edtr-io/edtr-io/actions/workflows/deploy.yml) will be triggered on GitHub
10. Once the GitHub workflow is complete, check the packages on NPM
11. Inform the maintainers of package consumers ([frontend](https://github.com/serlo/frontend), [RLP editor integration](https://github.com/serlo/ece-as-a-service), ...?) about the release, providing the version and which packages changed, and any potential breaking changes
8. `git commit -m "release X.X.X"` - commit the changes with the correct release version and push them to your branch. This increases the version number of all packages to the same number.
9. Open a PR from the release branch to `main`
10. Merge your PR, and a [deploy workflow](https://github.com/edtr-io/edtr-io/actions/workflows/deploy.yml) will be triggered on GitHub
11. Once the GitHub workflow is complete, check the packages on NPM
12. Inform the maintainers of package consumers ([frontend](https://github.com/serlo/frontend), [RLP editor integration](https://github.com/serlo/ece-as-a-service), ...?) about the release, providing the version and which packages changed, and any potential breaking changes

No package consumers will be affected by the release until they actually upgrade the version in their projects.

Expand Down
2 changes: 1 addition & 1 deletion api/plugin-text.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ export interface ListItemText {
// (undocumented)
children: CustomText[];
// (undocumented)
type: 'list-item-text';
type: 'list-item-child';
}

// @public (undocumented)
Expand Down
2 changes: 1 addition & 1 deletion lerna.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@
],
"npmClient": "yarn",
"useWorkspaces": true,
"version": "3.0.1"
"version": "3.0.2"
}
4 changes: 2 additions & 2 deletions packages/plugins/anchor/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@edtr-io/plugin-anchor",
"version": "3.0.1",
"version": "3.0.2",
"license": "MIT",
"author": "edtr.io Consortium",
"main": "dist/index.js",
Expand All @@ -12,7 +12,7 @@
"build": "ts-node ../../../scripts/build"
},
"dependencies": {
"@edtr-io/editor-ui": "^3.0.1",
"@edtr-io/editor-ui": "^3.0.2",
"@edtr-io/plugin": "^3.0.1",
"@edtr-io/ui": "^3.0.1",
"@types/react": "^18.0.27",
Expand Down
4 changes: 2 additions & 2 deletions packages/plugins/blockquote/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@edtr-io/plugin-blockquote",
"version": "3.0.1",
"version": "3.0.2",
"license": "MIT",
"author": "edtr.io Consortium",
"main": "dist/index.js",
Expand All @@ -19,7 +19,7 @@
},
"devDependencies": {
"@edtr-io/core": "^3.0.1",
"@edtr-io/plugin-text": "^3.0.1",
"@edtr-io/plugin-text": "^3.0.2",
"@fortawesome/fontawesome-svg-core": "^6.2.0",
"@fortawesome/free-solid-svg-icons": "^6.2.0",
"@fortawesome/react-fontawesome": "^0.1.18",
Expand Down
4 changes: 2 additions & 2 deletions packages/plugins/files/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@edtr-io/plugin-files",
"version": "3.0.1",
"version": "3.0.2",
"license": "MIT",
"author": "edtr.io Consortium",
"main": "dist/index.js",
Expand All @@ -12,7 +12,7 @@
"build": "ts-node ../../../scripts/build"
},
"dependencies": {
"@edtr-io/editor-ui": "^3.0.1",
"@edtr-io/editor-ui": "^3.0.2",
"@edtr-io/plugin": "^3.0.1",
"@edtr-io/ui": "^3.0.1",
"@types/react": "^18.0.27",
Expand Down
4 changes: 2 additions & 2 deletions packages/plugins/geogebra/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@edtr-io/plugin-geogebra",
"version": "3.0.1",
"version": "3.0.2",
"license": "MIT",
"author": "edtr.io Consortium",
"main": "dist/index.js",
Expand All @@ -12,7 +12,7 @@
"build": "ts-node ../../../scripts/build"
},
"dependencies": {
"@edtr-io/editor-ui": "^3.0.1",
"@edtr-io/editor-ui": "^3.0.2",
"@edtr-io/plugin": "^3.0.1",
"@edtr-io/ui": "^3.0.1",
"@types/lodash": "^4.14.181",
Expand Down
4 changes: 2 additions & 2 deletions packages/plugins/highlight/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@edtr-io/plugin-highlight",
"version": "3.0.1",
"version": "3.0.2",
"license": "MIT",
"author": "edtr.io Consortium",
"main": "dist/index.js",
Expand All @@ -12,7 +12,7 @@
"build": "ts-node ../../../scripts/build"
},
"dependencies": {
"@edtr-io/editor-ui": "^3.0.1",
"@edtr-io/editor-ui": "^3.0.2",
"@edtr-io/plugin": "^3.0.1",
"@edtr-io/ui": "^3.0.1",
"@types/ramda": "^0.28.5",
Expand Down
4 changes: 2 additions & 2 deletions packages/plugins/image/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@edtr-io/plugin-image",
"version": "3.0.1",
"version": "3.0.2",
"license": "MIT",
"author": "edtr.io Consortium",
"main": "dist/index.js",
Expand All @@ -12,7 +12,7 @@
"build": "ts-node ../../../scripts/build"
},
"dependencies": {
"@edtr-io/editor-ui": "^3.0.1",
"@edtr-io/editor-ui": "^3.0.2",
"@edtr-io/plugin": "^3.0.1",
"@edtr-io/store": "^3.0.1",
"@edtr-io/ui": "^3.0.1",
Expand Down
6 changes: 3 additions & 3 deletions packages/plugins/input-exercise/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@edtr-io/plugin-input-exercise",
"version": "3.0.1",
"version": "3.0.2",
"license": "MIT",
"author": "edtr.io Consortium",
"main": "dist/index.js",
Expand All @@ -12,7 +12,7 @@
"build": "ts-node ../../../scripts/build"
},
"dependencies": {
"@edtr-io/editor-ui": "^3.0.1",
"@edtr-io/editor-ui": "^3.0.2",
"@edtr-io/internal__dev-expression": "^3.0.0",
"@edtr-io/plugin": "^3.0.1",
"@edtr-io/renderer-ui": "^3.0.1",
Expand All @@ -28,7 +28,7 @@
},
"devDependencies": {
"@edtr-io/core": "^3.0.1",
"@edtr-io/plugin-text": "^3.0.1",
"@edtr-io/plugin-text": "^3.0.2",
"@edtr-io/renderer": "^3.0.1",
"@fortawesome/fontawesome-svg-core": "^6.2.0",
"@fortawesome/free-solid-svg-icons": "^6.2.0",
Expand Down
12 changes: 6 additions & 6 deletions packages/plugins/multimedia-explanation/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@edtr-io/plugin-multimedia-explanation",
"version": "3.0.1",
"version": "3.0.2",
"license": "MIT",
"author": "edtr.io Consortium",
"main": "dist/index.js",
Expand All @@ -12,7 +12,7 @@
"build": "ts-node ../../../scripts/build"
},
"dependencies": {
"@edtr-io/editor-ui": "^3.0.1",
"@edtr-io/editor-ui": "^3.0.2",
"@edtr-io/plugin": "^3.0.1",
"@edtr-io/store": "^3.0.1",
"@edtr-io/ui": "^3.0.1",
Expand All @@ -26,10 +26,10 @@
},
"devDependencies": {
"@edtr-io/core": "^3.0.1",
"@edtr-io/plugin-geogebra": "^3.0.1",
"@edtr-io/plugin-image": "^3.0.1",
"@edtr-io/plugin-rows": "^3.0.1",
"@edtr-io/plugin-video": "^3.0.1",
"@edtr-io/plugin-geogebra": "^3.0.2",
"@edtr-io/plugin-image": "^3.0.2",
"@edtr-io/plugin-rows": "^3.0.2",
"@edtr-io/plugin-video": "^3.0.2",
"@fortawesome/fontawesome-svg-core": "^6.2.0",
"@fortawesome/free-solid-svg-icons": "^6.2.0",
"@fortawesome/react-fontawesome": "^0.1.18",
Expand Down
6 changes: 3 additions & 3 deletions packages/plugins/rows/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@edtr-io/plugin-rows",
"version": "3.0.1",
"version": "3.0.2",
"license": "MIT",
"author": "edtr.io Consortium",
"main": "dist/index.js",
Expand All @@ -12,7 +12,7 @@
"build": "ts-node ../../../scripts/build"
},
"dependencies": {
"@edtr-io/editor-ui": "^3.0.1",
"@edtr-io/editor-ui": "^3.0.2",
"@edtr-io/plugin": "^3.0.1",
"@edtr-io/store": "^3.0.1",
"@edtr-io/ui": "^3.0.1",
Expand All @@ -24,7 +24,7 @@
},
"devDependencies": {
"@edtr-io/core": "^3.0.1",
"@edtr-io/plugin-text": "^3.0.1",
"@edtr-io/plugin-text": "^3.0.2",
"@fortawesome/fontawesome-svg-core": "^6.2.0",
"@fortawesome/free-solid-svg-icons": "^6.2.0",
"@fortawesome/react-fontawesome": "^0.1.18",
Expand Down
6 changes: 3 additions & 3 deletions packages/plugins/sc-mc-exercise/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@edtr-io/plugin-sc-mc-exercise",
"version": "3.0.1",
"version": "3.0.2",
"license": "MIT",
"author": "edtr.io Consortium",
"main": "dist/index.js",
Expand All @@ -12,7 +12,7 @@
"build": "ts-node ../../../scripts/build"
},
"dependencies": {
"@edtr-io/editor-ui": "^3.0.1",
"@edtr-io/editor-ui": "^3.0.2",
"@edtr-io/plugin": "^3.0.1",
"@edtr-io/renderer-ui": "^3.0.1",
"@edtr-io/store": "^3.0.1",
Expand All @@ -25,7 +25,7 @@
},
"devDependencies": {
"@edtr-io/core": "^3.0.1",
"@edtr-io/plugin-text": "^3.0.1",
"@edtr-io/plugin-text": "^3.0.2",
"@fortawesome/fontawesome-svg-core": "^6.2.0",
"@fortawesome/free-solid-svg-icons": "^6.2.0",
"@fortawesome/react-fontawesome": "^0.1.18",
Expand Down
4 changes: 2 additions & 2 deletions packages/plugins/serlo-injection/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@edtr-io/plugin-serlo-injection",
"version": "3.0.1",
"version": "3.0.2",
"license": "MIT",
"author": "edtr.io Consortium",
"main": "dist/index.js",
Expand All @@ -12,7 +12,7 @@
"build": "ts-node ../../../scripts/build"
},
"dependencies": {
"@edtr-io/editor-ui": "^3.0.1",
"@edtr-io/editor-ui": "^3.0.2",
"@edtr-io/plugin": "^3.0.1",
"@edtr-io/ui": "^3.0.1",
"@types/react": "^18.0.27",
Expand Down
8 changes: 4 additions & 4 deletions packages/plugins/spoiler/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@edtr-io/plugin-spoiler",
"version": "3.0.1",
"version": "3.0.2",
"license": "MIT",
"author": "edtr.io Consortium",
"main": "dist/index.js",
Expand All @@ -12,7 +12,7 @@
"build": "ts-node ../../../scripts/build"
},
"dependencies": {
"@edtr-io/editor-ui": "^3.0.1",
"@edtr-io/editor-ui": "^3.0.2",
"@edtr-io/plugin": "^3.0.1",
"@edtr-io/renderer-ui": "^3.0.1",
"@edtr-io/ui": "^3.0.1",
Expand All @@ -24,8 +24,8 @@
},
"devDependencies": {
"@edtr-io/core": "^3.0.1",
"@edtr-io/plugin-rows": "^3.0.1",
"@edtr-io/plugin-text": "^3.0.1",
"@edtr-io/plugin-rows": "^3.0.2",
"@edtr-io/plugin-text": "^3.0.2",
"@fortawesome/fontawesome-svg-core": "^6.2.0",
"@fortawesome/free-solid-svg-icons": "^6.2.0",
"@fortawesome/react-fontawesome": "^0.1.18",
Expand Down
4 changes: 2 additions & 2 deletions packages/plugins/table/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@edtr-io/plugin-table",
"version": "3.0.1",
"version": "3.0.2",
"license": "MIT",
"author": "edtr.io Consortium",
"main": "dist/index.js",
Expand All @@ -12,7 +12,7 @@
"build": "ts-node ../../../scripts/build"
},
"dependencies": {
"@edtr-io/editor-ui": "^3.0.1",
"@edtr-io/editor-ui": "^3.0.2",
"@edtr-io/plugin": "^3.0.1",
"@edtr-io/ui": "^3.0.1",
"@types/react": "^18.0.27",
Expand Down
8 changes: 4 additions & 4 deletions packages/plugins/text/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@edtr-io/plugin-text",
"version": "3.0.1",
"version": "3.0.2",
"license": "MIT",
"author": "edtr.io Consortium",
"main": "dist/index.js",
Expand All @@ -13,10 +13,10 @@
},
"dependencies": {
"@convertkit/slate-lists": "^0.2.11",
"@edtr-io/editor-ui": "^3.0.1",
"@edtr-io/math": "^3.0.1",
"@edtr-io/editor-ui": "^3.0.2",
"@edtr-io/math": "^3.0.2",
"@edtr-io/plugin": "^3.0.1",
"@edtr-io/plugin-rows": "^3.0.1",
"@edtr-io/plugin-rows": "^3.0.2",
"@edtr-io/store": "^3.0.1",
"@edtr-io/ui": "^3.0.1",
"@prezly/slate-lists": "^0.79.5",
Expand Down
2 changes: 1 addition & 1 deletion packages/plugins/text/src/components/text-editor.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ function renderElementWithFocused(focused: boolean) {
if (element.type === 'list-item') {
return <li {...attributes}>{children}</li>
}
if (element.type === 'list-item-text') {
if (element.type === 'list-item-child') {
return <div {...attributes}>{children}</div>
}

Expand Down
4 changes: 2 additions & 2 deletions packages/plugins/text/src/plugins/lists.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ export const withLists = (editor: SlateEditor) => {
return Element.isElementType(node, 'list-item')
},
isListItemTextNode(node: Node) {
return Element.isElementType(node, 'list-item-text')
return Element.isElementType(node, 'list-item-child')
},
createDefaultTextNode(props = {}) {
return { children: [{ text: '' }], ...props, type: 'p' } as Paragraph
Expand All @@ -59,7 +59,7 @@ export const withLists = (editor: SlateEditor) => {
return {
children: [{ text: '' }],
...props,
type: 'list-item-text',
type: 'list-item-child',
} as ListItemText
},
})
Expand Down
2 changes: 1 addition & 1 deletion packages/plugins/text/src/types/text-editor.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ export interface ListItem {

/** @public */
export interface ListItemText {
type: 'list-item-text'
type: 'list-item-child'
children: CustomText[]
}

Expand Down
1 change: 0 additions & 1 deletion packages/plugins/text/src/utils/link.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ export function toggleLink(editor: SlateEditor) {
const isCollapsed = selection && Range.isCollapsed(selection)

if (isCollapsed) {
// TODO: how set focus to input field, when it is newly created?
Transforms.insertNodes(editor, {
type: 'a',
href: '',
Expand Down
Loading

0 comments on commit 7b40bce

Please sign in to comment.