diff --git a/CHANGELOG.md b/CHANGELOG.md index 4a620e82cbb..80dc343ce6d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,7 @@ # Changelog +[Link to all migration guides](https://yew.rs/docs/category/migration-guides) + ## ✨ yew **0.21.0** *(2023-09-23)* #### Changelog diff --git a/tools/changelog/src/write_changelog_file.rs b/tools/changelog/src/write_changelog_file.rs index 976d5a65cfb..d78096cad4a 100644 --- a/tools/changelog/src/write_changelog_file.rs +++ b/tools/changelog/src/write_changelog_file.rs @@ -20,7 +20,8 @@ pub fn write_changelog(changelog_path: &str, version_changelog: &[u8]) -> Result new_changelog.write_all(version_changelog)?; - for old_line in old_changelog_reader.lines().skip(2) { + // The `.skip` skips the title and link to the migration guide + for old_line in old_changelog_reader.lines().skip(4) { writeln!(new_changelog, "{}", old_line?)?; } diff --git a/tools/changelog/src/write_version_changelog.rs b/tools/changelog/src/write_version_changelog.rs index 806e6f7c384..a003aadda1a 100644 --- a/tools/changelog/src/write_version_changelog.rs +++ b/tools/changelog/src/write_version_changelog.rs @@ -17,6 +17,12 @@ pub fn write_changelog_file( writeln!(version_only_changelog, "# Changelog")?; writeln!(version_only_changelog)?; + writeln!( + version_only_changelog, + "[Link to all migration guides](https://yew.rs/docs/category/migration-guides)" + )?; + writeln!(version_only_changelog)?; + writeln!( version_only_changelog, "## ✨ {package} **{next_version}** *({release_date})* Changelog", diff --git a/tools/changelog/tests/generate_yew_changelog_file.rs b/tools/changelog/tests/generate_yew_changelog_file.rs index 56a80cb4f0b..b92e06a10e5 100644 --- a/tools/changelog/tests/generate_yew_changelog_file.rs +++ b/tools/changelog/tests/generate_yew_changelog_file.rs @@ -62,7 +62,7 @@ fn generate_yew_changelog_file() -> Result<()> { let lines = expected_reader_lines.zip(after_reader_lines); for (i, (expected_line, after_line)) in lines.enumerate() { - if i == 2 || i == 13 { + if i == 4 || i == 15 { // these lines have dynamic things that may break the tests let expected_line_updated = expected_line?.replace( "date_goes_here", diff --git a/tools/changelog/tests/test_base.md b/tools/changelog/tests/test_base.md index fe504d9191f..63f248167bc 100644 --- a/tools/changelog/tests/test_base.md +++ b/tools/changelog/tests/test_base.md @@ -1,5 +1,7 @@ # Changelog for its generation tests +[Link to all migration guides](https://yew.rs/docs/category/migration-guides) + ## ✨ yew **0.19.0** *(2021-11-26)* #### Changelog diff --git a/tools/changelog/tests/test_expected.md b/tools/changelog/tests/test_expected.md index 5e186956986..44c439a96e4 100644 --- a/tools/changelog/tests/test_expected.md +++ b/tools/changelog/tests/test_expected.md @@ -1,21 +1,23 @@ # Changelog +[Link to all migration guides](https://yew.rs/docs/category/migration-guides) + ## ✨ yew **0.0.0** *(date_goes_here)* Changelog ### ⚡️ Features -- Incremental performance improvements to element creation. [[@Greg Johnston](https://github.com/Greg Johnston), [#3169](https://github.com/yewstack/yew/pull/3169)] +- Incremental performance improvements to element creation. [[@Greg Johnston](https://github.com/gbj), [#3169](https://github.com/yewstack/yew/pull/3169)] ### 🚨 Breaking changes -- Enable PartialEq for all virtual dom types. [[@Kaede Hoshikawa](https://github.com/Kaede Hoshikawa), [#3206](https://github.com/yewstack/yew/pull/3206)] -- Pass hook dependencies as the first function argument. [[@Arniu Tseng](https://github.com/Arniu Tseng), [#2861](https://github.com/yewstack/yew/pull/2861)] +- Enable PartialEq for all virtual dom types. [[@Kaede Hoshikawa](https://github.com/futursolo), [#3206](https://github.com/yewstack/yew/pull/3206)] +- Pass hook dependencies as the first function argument. [[@Arniu Tseng](https://github.com/arniu), [#2861](https://github.com/yewstack/yew/pull/2861)] ## ✨ yew **0.0.0** *(date_goes_here)* Changelog ### 🛠 Fixes -- Fix defaulted type parameter.. [[@Kaede Hoshikawa](https://github.com/Kaede Hoshikawa), [#2284](https://github.com/yewstack/yew/pull/2284)] +- Fix defaulted type parameter.. [[@Kaede Hoshikawa](https://github.com/futursolo), [#2284](https://github.com/yewstack/yew/pull/2284)] ### ⚡️ Features diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current.json b/website/i18n/ja/docusaurus-plugin-content-docs/current.json index 8f32da8664f..04cdeac5295 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/current.json +++ b/website/i18n/ja/docusaurus-plugin-content-docs/current.json @@ -82,5 +82,21 @@ "sidebar.docs.category.Struct Components": { "message": "Struct Components", "description": "The label for category Struct Components in sidebar docs" + }, + "sidebar.docs.category.Migration guides.link.generated-index.title": { + "message": "Migration guides", + "description": "The generated-index page title for category Migration guides in sidebar docs" + }, + "sidebar.docs.category.yew.link.generated-index.title": { + "message": "yew", + "description": "The generated-index page title for category yew in sidebar docs" + }, + "sidebar.docs.category.yew-agent.link.generated-index.title": { + "message": "yew-agent", + "description": "The generated-index page title for category yew-agent in sidebar docs" + }, + "sidebar.docs.category.yew-router.link.generated-index.title": { + "message": "yew-router", + "description": "The generated-index page title for category yew-router in sidebar docs" } } diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/version-0.19.0.json b/website/i18n/ja/docusaurus-plugin-content-docs/version-0.19.0.json index 5470b3f1966..754534d1b58 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/version-0.19.0.json +++ b/website/i18n/ja/docusaurus-plugin-content-docs/version-0.19.0.json @@ -54,5 +54,21 @@ "sidebar.sidebar.category.yew-router": { "message": "yew-router", "description": "The label for category yew-router in sidebar sidebar" + }, + "sidebar.sidebar.category.Migration guides.link.generated-index.title": { + "message": "Migration guides", + "description": "The generated-index page title for category Migration guides in sidebar sidebar" + }, + "sidebar.sidebar.category.yew.link.generated-index.title": { + "message": "yew", + "description": "The generated-index page title for category yew in sidebar sidebar" + }, + "sidebar.sidebar.category.yew-agent.link.generated-index.title": { + "message": "yew-agent", + "description": "The generated-index page title for category yew-agent in sidebar sidebar" + }, + "sidebar.sidebar.category.yew-router.link.generated-index.title": { + "message": "yew-router", + "description": "The generated-index page title for category yew-router in sidebar sidebar" } } diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/version-0.20.json b/website/i18n/ja/docusaurus-plugin-content-docs/version-0.20.json index 1a16f2cd035..e4fa66fefc4 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/version-0.20.json +++ b/website/i18n/ja/docusaurus-plugin-content-docs/version-0.20.json @@ -82,5 +82,21 @@ "sidebar.docs.category.yew-router": { "message": "yew-router", "description": "The label for category yew-router in sidebar docs" + }, + "sidebar.docs.category.Migration guides.link.generated-index.title": { + "message": "Migration guides", + "description": "The generated-index page title for category Migration guides in sidebar docs" + }, + "sidebar.docs.category.yew.link.generated-index.title": { + "message": "yew", + "description": "The generated-index page title for category yew in sidebar docs" + }, + "sidebar.docs.category.yew-agent.link.generated-index.title": { + "message": "yew-agent", + "description": "The generated-index page title for category yew-agent in sidebar docs" + }, + "sidebar.docs.category.yew-router.link.generated-index.title": { + "message": "yew-router", + "description": "The generated-index page title for category yew-router in sidebar docs" } } diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/version-0.21.json b/website/i18n/ja/docusaurus-plugin-content-docs/version-0.21.json index 0ab4c0608c2..08347df3368 100644 --- a/website/i18n/ja/docusaurus-plugin-content-docs/version-0.21.json +++ b/website/i18n/ja/docusaurus-plugin-content-docs/version-0.21.json @@ -82,5 +82,21 @@ "sidebar.docs.category.yew-router": { "message": "yew-router", "description": "The label for category yew-router in sidebar docs" + }, + "sidebar.docs.category.Migration guides.link.generated-index.title": { + "message": "Migration guides", + "description": "The generated-index page title for category Migration guides in sidebar docs" + }, + "sidebar.docs.category.yew.link.generated-index.title": { + "message": "yew", + "description": "The generated-index page title for category yew in sidebar docs" + }, + "sidebar.docs.category.yew-agent.link.generated-index.title": { + "message": "yew-agent", + "description": "The generated-index page title for category yew-agent in sidebar docs" + }, + "sidebar.docs.category.yew-router.link.generated-index.title": { + "message": "yew-router", + "description": "The generated-index page title for category yew-router in sidebar docs" } } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json index 5f3e467d264..5b359b27df7 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json @@ -82,5 +82,21 @@ "sidebar.docs.category.Struct Components": { "message": "Struct Components", "description": "The label for category Struct Components in sidebar docs" + }, + "sidebar.docs.category.Migration guides.link.generated-index.title": { + "message": "Migration guides", + "description": "The generated-index page title for category Migration guides in sidebar docs" + }, + "sidebar.docs.category.yew.link.generated-index.title": { + "message": "yew", + "description": "The generated-index page title for category yew in sidebar docs" + }, + "sidebar.docs.category.yew-agent.link.generated-index.title": { + "message": "yew-agent", + "description": "The generated-index page title for category yew-agent in sidebar docs" + }, + "sidebar.docs.category.yew-router.link.generated-index.title": { + "message": "yew-router", + "description": "The generated-index page title for category yew-router in sidebar docs" } } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/version-0.19.0.json b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/version-0.19.0.json index 5470b3f1966..754534d1b58 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/version-0.19.0.json +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/version-0.19.0.json @@ -54,5 +54,21 @@ "sidebar.sidebar.category.yew-router": { "message": "yew-router", "description": "The label for category yew-router in sidebar sidebar" + }, + "sidebar.sidebar.category.Migration guides.link.generated-index.title": { + "message": "Migration guides", + "description": "The generated-index page title for category Migration guides in sidebar sidebar" + }, + "sidebar.sidebar.category.yew.link.generated-index.title": { + "message": "yew", + "description": "The generated-index page title for category yew in sidebar sidebar" + }, + "sidebar.sidebar.category.yew-agent.link.generated-index.title": { + "message": "yew-agent", + "description": "The generated-index page title for category yew-agent in sidebar sidebar" + }, + "sidebar.sidebar.category.yew-router.link.generated-index.title": { + "message": "yew-router", + "description": "The generated-index page title for category yew-router in sidebar sidebar" } } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/version-0.20.json b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/version-0.20.json index 1a16f2cd035..e4fa66fefc4 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/version-0.20.json +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/version-0.20.json @@ -82,5 +82,21 @@ "sidebar.docs.category.yew-router": { "message": "yew-router", "description": "The label for category yew-router in sidebar docs" + }, + "sidebar.docs.category.Migration guides.link.generated-index.title": { + "message": "Migration guides", + "description": "The generated-index page title for category Migration guides in sidebar docs" + }, + "sidebar.docs.category.yew.link.generated-index.title": { + "message": "yew", + "description": "The generated-index page title for category yew in sidebar docs" + }, + "sidebar.docs.category.yew-agent.link.generated-index.title": { + "message": "yew-agent", + "description": "The generated-index page title for category yew-agent in sidebar docs" + }, + "sidebar.docs.category.yew-router.link.generated-index.title": { + "message": "yew-router", + "description": "The generated-index page title for category yew-router in sidebar docs" } } diff --git a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/version-0.21.json b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/version-0.21.json index 0ab4c0608c2..08347df3368 100644 --- a/website/i18n/zh-Hans/docusaurus-plugin-content-docs/version-0.21.json +++ b/website/i18n/zh-Hans/docusaurus-plugin-content-docs/version-0.21.json @@ -82,5 +82,21 @@ "sidebar.docs.category.yew-router": { "message": "yew-router", "description": "The label for category yew-router in sidebar docs" + }, + "sidebar.docs.category.Migration guides.link.generated-index.title": { + "message": "Migration guides", + "description": "The generated-index page title for category Migration guides in sidebar docs" + }, + "sidebar.docs.category.yew.link.generated-index.title": { + "message": "yew", + "description": "The generated-index page title for category yew in sidebar docs" + }, + "sidebar.docs.category.yew-agent.link.generated-index.title": { + "message": "yew-agent", + "description": "The generated-index page title for category yew-agent in sidebar docs" + }, + "sidebar.docs.category.yew-router.link.generated-index.title": { + "message": "yew-router", + "description": "The generated-index page title for category yew-router in sidebar docs" } } diff --git a/website/i18n/zh-Hant/docusaurus-plugin-content-docs/current.json b/website/i18n/zh-Hant/docusaurus-plugin-content-docs/current.json index aea5f2e5ca3..ffe431a0aee 100644 --- a/website/i18n/zh-Hant/docusaurus-plugin-content-docs/current.json +++ b/website/i18n/zh-Hant/docusaurus-plugin-content-docs/current.json @@ -82,5 +82,21 @@ "sidebar.docs.category.Struct Components": { "message": "Struct Components", "description": "The label for category Struct Components in sidebar docs" + }, + "sidebar.docs.category.Migration guides.link.generated-index.title": { + "message": "Migration guides", + "description": "The generated-index page title for category Migration guides in sidebar docs" + }, + "sidebar.docs.category.yew.link.generated-index.title": { + "message": "yew", + "description": "The generated-index page title for category yew in sidebar docs" + }, + "sidebar.docs.category.yew-agent.link.generated-index.title": { + "message": "yew-agent", + "description": "The generated-index page title for category yew-agent in sidebar docs" + }, + "sidebar.docs.category.yew-router.link.generated-index.title": { + "message": "yew-router", + "description": "The generated-index page title for category yew-router in sidebar docs" } } diff --git a/website/i18n/zh-Hant/docusaurus-plugin-content-docs/version-0.19.0.json b/website/i18n/zh-Hant/docusaurus-plugin-content-docs/version-0.19.0.json index 5470b3f1966..754534d1b58 100644 --- a/website/i18n/zh-Hant/docusaurus-plugin-content-docs/version-0.19.0.json +++ b/website/i18n/zh-Hant/docusaurus-plugin-content-docs/version-0.19.0.json @@ -54,5 +54,21 @@ "sidebar.sidebar.category.yew-router": { "message": "yew-router", "description": "The label for category yew-router in sidebar sidebar" + }, + "sidebar.sidebar.category.Migration guides.link.generated-index.title": { + "message": "Migration guides", + "description": "The generated-index page title for category Migration guides in sidebar sidebar" + }, + "sidebar.sidebar.category.yew.link.generated-index.title": { + "message": "yew", + "description": "The generated-index page title for category yew in sidebar sidebar" + }, + "sidebar.sidebar.category.yew-agent.link.generated-index.title": { + "message": "yew-agent", + "description": "The generated-index page title for category yew-agent in sidebar sidebar" + }, + "sidebar.sidebar.category.yew-router.link.generated-index.title": { + "message": "yew-router", + "description": "The generated-index page title for category yew-router in sidebar sidebar" } } diff --git a/website/i18n/zh-Hant/docusaurus-plugin-content-docs/version-0.20.json b/website/i18n/zh-Hant/docusaurus-plugin-content-docs/version-0.20.json index 1a16f2cd035..e4fa66fefc4 100644 --- a/website/i18n/zh-Hant/docusaurus-plugin-content-docs/version-0.20.json +++ b/website/i18n/zh-Hant/docusaurus-plugin-content-docs/version-0.20.json @@ -82,5 +82,21 @@ "sidebar.docs.category.yew-router": { "message": "yew-router", "description": "The label for category yew-router in sidebar docs" + }, + "sidebar.docs.category.Migration guides.link.generated-index.title": { + "message": "Migration guides", + "description": "The generated-index page title for category Migration guides in sidebar docs" + }, + "sidebar.docs.category.yew.link.generated-index.title": { + "message": "yew", + "description": "The generated-index page title for category yew in sidebar docs" + }, + "sidebar.docs.category.yew-agent.link.generated-index.title": { + "message": "yew-agent", + "description": "The generated-index page title for category yew-agent in sidebar docs" + }, + "sidebar.docs.category.yew-router.link.generated-index.title": { + "message": "yew-router", + "description": "The generated-index page title for category yew-router in sidebar docs" } } diff --git a/website/i18n/zh-Hant/docusaurus-plugin-content-docs/version-0.21.json b/website/i18n/zh-Hant/docusaurus-plugin-content-docs/version-0.21.json index 0ab4c0608c2..08347df3368 100644 --- a/website/i18n/zh-Hant/docusaurus-plugin-content-docs/version-0.21.json +++ b/website/i18n/zh-Hant/docusaurus-plugin-content-docs/version-0.21.json @@ -82,5 +82,21 @@ "sidebar.docs.category.yew-router": { "message": "yew-router", "description": "The label for category yew-router in sidebar docs" + }, + "sidebar.docs.category.Migration guides.link.generated-index.title": { + "message": "Migration guides", + "description": "The generated-index page title for category Migration guides in sidebar docs" + }, + "sidebar.docs.category.yew.link.generated-index.title": { + "message": "yew", + "description": "The generated-index page title for category yew in sidebar docs" + }, + "sidebar.docs.category.yew-agent.link.generated-index.title": { + "message": "yew-agent", + "description": "The generated-index page title for category yew-agent in sidebar docs" + }, + "sidebar.docs.category.yew-router.link.generated-index.title": { + "message": "yew-router", + "description": "The generated-index page title for category yew-router in sidebar docs" } } diff --git a/website/sidebars/docs.js b/website/sidebars/docs.js index 6d93cefb22d..726612abf99 100644 --- a/website/sidebars/docs.js +++ b/website/sidebars/docs.js @@ -149,10 +149,18 @@ module.exports = { { type: 'category', label: 'Migration guides', + link: { + type: 'generated-index', + title: 'Migration guides', + }, items: [ { type: 'category', label: 'yew', + link: { + type: 'generated-index', + title: 'yew', + }, items: [ 'migration-guides/yew/from-0_20_0-to-0_21_0', 'migration-guides/yew/from-0_19_0-to-0_20_0', @@ -162,6 +170,10 @@ module.exports = { { type: 'category', label: 'yew-agent', + link: { + type: 'generated-index', + title: 'yew-agent', + }, items: [ 'migration-guides/yew-agent/from-0_1_0-to-0_2_0', 'migration-guides/yew-agent/from-0_0_0-to-0_1_0', @@ -170,6 +182,10 @@ module.exports = { { type: 'category', label: 'yew-router', + link: { + type: 'generated-index', + title: 'yew-router', + }, items: [ 'migration-guides/yew-router/from-0_16_0-to-0_17_0', 'migration-guides/yew-router/from-0_15_0-to-0_16_0', diff --git a/website/versioned_sidebars/version-0.19.0-sidebars.json b/website/versioned_sidebars/version-0.19.0-sidebars.json index 9ac525f5493..a0571a4efca 100644 --- a/website/versioned_sidebars/version-0.19.0-sidebars.json +++ b/website/versioned_sidebars/version-0.19.0-sidebars.json @@ -231,10 +231,18 @@ { "type": "category", "label": "Migration guides", + "link": { + "type": "generated-index", + "title": "Migration guides" + }, "items": [ { "type": "category", "label": "yew", + "link": { + "type": "generated-index", + "title": "yew" + }, "items": [ { "type": "doc", @@ -247,6 +255,10 @@ { "type": "category", "label": "yew-agent", + "link": { + "type": "generated-index", + "title": "yew-agent" + }, "items": [ { "type": "doc", @@ -259,6 +271,10 @@ { "type": "category", "label": "yew-router", + "link": { + "type": "generated-index", + "title": "yew-router" + }, "items": [ { "type": "doc", diff --git a/website/versioned_sidebars/version-0.20-sidebars.json b/website/versioned_sidebars/version-0.20-sidebars.json index ba2bb23a627..a6ae56f8f42 100644 --- a/website/versioned_sidebars/version-0.20-sidebars.json +++ b/website/versioned_sidebars/version-0.20-sidebars.json @@ -142,10 +142,18 @@ { "type": "category", "label": "Migration guides", + "link": { + "type": "generated-index", + "title": "Migration guides" + }, "items": [ { "type": "category", "label": "yew", + "link": { + "type": "generated-index", + "title": "yew" + }, "items": [ "migration-guides/yew/from-0_18_0-to-0_19_0", "migration-guides/yew/from-0_19_0-to-0_20_0" @@ -154,6 +162,10 @@ { "type": "category", "label": "yew-agent", + "link": { + "type": "generated-index", + "title": "yew-agent" + }, "items": [ "migration-guides/yew-agent/from-0_0_0-to-0_1_0", "migration-guides/yew-agent/from-0_1_0-to-0_2_0" @@ -162,6 +174,10 @@ { "type": "category", "label": "yew-router", + "link": { + "type": "generated-index", + "title": "yew-router" + }, "items": [ "migration-guides/yew-router/from-0_15_0-to-0_16_0", "migration-guides/yew-router/from-0_16_0-to-0_17_0" diff --git a/website/versioned_sidebars/version-0.21-sidebars.json b/website/versioned_sidebars/version-0.21-sidebars.json index 1fb8bea8bff..a33dc1c8135 100644 --- a/website/versioned_sidebars/version-0.21-sidebars.json +++ b/website/versioned_sidebars/version-0.21-sidebars.json @@ -142,10 +142,18 @@ { "type": "category", "label": "Migration guides", + "link": { + "type": "generated-index", + "title": "Migration guides" + }, "items": [ { "type": "category", "label": "yew", + "link": { + "type": "generated-index", + "title": "yew" + }, "items": [ "migration-guides/yew/from-0_20_0-to-0_21_0", "migration-guides/yew/from-0_19_0-to-0_20_0", @@ -155,6 +163,10 @@ { "type": "category", "label": "yew-agent", + "link": { + "type": "generated-index", + "title": "yew-agent" + }, "items": [ "migration-guides/yew-agent/from-0_1_0-to-0_2_0", "migration-guides/yew-agent/from-0_0_0-to-0_1_0" @@ -163,6 +175,10 @@ { "type": "category", "label": "yew-router", + "link": { + "type": "generated-index", + "title": "yew-router" + }, "items": [ "migration-guides/yew-router/from-0_16_0-to-0_17_0", "migration-guides/yew-router/from-0_15_0-to-0_16_0"