Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade KDS to the latest on the develop branch #11761

Closed
wants to merge 1 commit into from

Conversation

MisRob
Copy link
Member

@MisRob MisRob commented Jan 22, 2024

Summary

We forgot to keep develop up to date with the latest KDS for some time so this PR updates KDS version to the latest KDS commit. No changes are breaking and I haven't noticed any updates needed in Kolibri.

The relevant portion of the KDS changelog:

- [#522]
  - **Description:** Upgrades github-actions/cache dependency
  - **Products impact:** Dev dependency upgrade
  - **Addresses:** -
  - **Components:** -
  - **Breaking:** no
  - **Impacts a11y:** no
  - **Guidance:** -

[#522]: https://github.com/learningequality/kolibri-design-system/pull/522

- [#518]
  - **Description:** Add testing for KImg component
  - **Products impact:** none
  - **Addresses:** https://github.com/learningequality/kolibri-design-system/issues/512
  - **Components:** -
  - **Breaking:** no
  - **Impacts a11y:** no  - 
  - **Guidance:** -

[#518]: https://github.com/learningequality/kolibri-design-system/pull/518

- [#521]
  - **Description:** Move date-fns dependency to depencies rather than dev-dependencies.
  - **Products impact:** bugfix
  - **Addresses:** N/A
  - **Components:** KDateRange/KDateInput
  - **Breaking:** no
  - **Impacts a11y:** no
  - **Guidance:** ~

[#521]: [https://github.com/learningequality/kolibri-design-system/pull/521]

- [#509]
  - **Description:** Introduces `appearanceOverrides` prop for the `KImg` component
  - **Products impact:** new API 
  - **Addresses:** https://github.com/learningequality/kolibri-design-system/issues/371
  - **Components:** KImg
  - **Breaking:** No
  - **Impacts a11y:** No
  - **Guidance:** -

[#509]: https://github.com/learningequality/kolibri-design-system/pull/509

- [#516]
  - **Description:** Upgrades follow-redirects dependency
  - **Products impact:** Dependency upgrade
  - **Addresses:** -
  - **Components:** -
  - **Breaking:** no
  - **Impacts a11y:** no
  - **Guidance:** -

[#516]: https://github.com/learningequality/kolibri-design-system/pull/516

- [#508]
  - **Description:** Update Github maintained github actions to latest versions
  - **Products impact:** -
  - **Addresses:** -
  - **Components:** -
  - **Breaking:** no
  - **Impacts a11y:** no  
  - **Guidance:** -

[#508]: https://github.com/learningequality/kolibri-design-system/pull/508

- [#502]
  - **Description:** Add dispatching of 'error' event when failed to load image for 'KImg'
  - **Products impact:** new API
  - **Addresses:** https://github.com/learningequality/kolibri-design-system/issues/372
  - **Components:** KImg
  - **Breaking:** no
  - **Impacts a11y:** yes  
  - **Guidance:** Allows the consumer to hook into the lifecycle of 'KImg' and handle the cases when the image fails to load

[#502]: https://github.com/learningequality/kolibri-design-system/pull/502

- [#505]
  - **Description:**  Added custom implementation of GH action that checks that changelog is updated in each pull request
  - **Products impact:** none
  - **Addresses:** https://github.com/learningequality/kolibri-design-system/issues/481
  - **Components:** -
  - **Breaking:** 
  - **Impacts a11y:** 
  - **Guidance:** -

[#505]: https://github.com/learningequality/kolibri-design-system/pull/505

- [#493]
  - **Description:** Changed the value of z-index of KDropdownMenu to 99.
  - **Products impact:** Bugfix
  - **Addresses:** https://github.com/learningequality/kolibri-design-system/issues/486
  - **Components:** KDropdownMenu
  - **Breaking:** No
  - **Impacts a11y:** No
  - **Guidance:** -

[#493]: https://github.com/learningequality/kolibri-design-system/pull/493

- [#500]
  - **Description:** Upgrades vue-router dependency
  - **Products impact:** Dependency upgrade
  - **Addresses:** -
  - **Components:** -
  - **Breaking:** no
  - **Impacts a11y:** no
  - **Guidance:** -

[#500]: https://github.com/learningequality/kolibri-design-system/pull/500

- [#421]
  - **Description:** Upgrades kolibri-tools dependency and removes KDS' circular dependency on itself
  - **Products impact:** Dependency upgrade
  - **Addresses:** -
  - **Components:** -
  - **Breaking:** no
  - **Impacts a11y:** no
  - **Guidance:** -

[#421]: https://github.com/learningequality/kolibri-design-system/pull/421

- [#499]
  - **Description:** Upgrades @babel/traverse dependency to address security vulnerability
  - **Products impact:** Dependency upgrade
  - **Addresses:** -
  - **Components:** -
  - **Breaking:** no
  - **Impacts a11y:** no
  - **Guidance:** -

[#499]: https://github.com/learningequality/kolibri-design-system/pull/499

- [#467]
  - **Description:** Upgrades word-wrap dependency to address security vulnerability
  - **Products impact:** Dependency upgrade
  - **Addresses:** -
  - **Components:** -
  - **Breaking:** no
  - **Impacts a11y:** no
  - **Guidance:** -

[#467]: https://github.com/learningequality/kolibri-design-system/pull/467

- [#483]
  - **Description:** Upgrades browserify-sign dependency to address security vulnerability
  - **Products impact:** Dependency upgrade
  - **Addresses:** -
  - **Components:** -
  - **Breaking:** no
  - **Impacts a11y:** no
  - **Guidance:** -

[#483]: https://github.com/learningequality/kolibri-design-system/pull/483

- [#494]
  - **Description:** Update contributing guidelines
  - **Products impact:** none
  - **Addresses:** -
  - **Components:** -
  - **Breaking:** -
  - **Impacts a11y:** -
  - **Guidance:** -

[#494]: [https://github.com/learningequality/kolibri-design-system/pull/494]

- [#492]
  - **Description:** Add autofocus directive on KRadioButton to fix autofocus behavior on dynamic rendering.
  - **Products impact:** bugfix
  - **Addresses:** https://github.com/learningequality/kolibri-design-system/issues/489
  - **Components:** KRadioButton
  - **Breaking:** no
  - **Impacts a11y:** yes
  - **Guidance:** Add "autofocus" prop on KRadioButton. This change improves keyboard navigation on forms where a KRadioButton jumps into the DOM.

[#492]: https://github.com/learningequality/kolibri-design-system/pull/492

- [#497]
  - **Description:** KDropdownMenu now emits a @tab event when the user hits the [Tab] key and a @close event when the menu is closed programmatically. Additionally, a new icon for Expand All was added and can be used just like any other icon with the "expandAll" name.
  - **Products impact:** updated API
  - **Addresses:** -
  - **Components:** KDropdownMenu
  - **Breaking:** No
  - **Impacts a11y:** yes
  - **Guidance:**  The @tab event can be used for more precise focus management as the popover by default could end up sending focus to the root HTML element by default. Note that the browser event is passed to the handler function, so you may need/want to call `preventDefault()` on that event depending on your use case.

  [#497]: https://github.com/learningequality/kolibri-design-system/pull/497

Reviewer guidance

You could preview the changelog section pasted above and run Kolibri.


Testing checklist

  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Critical and brittle code paths are covered by unit tests

PR process

  • PR has the correct target branch and milestone
  • PR has 'needs review' or 'work-in-progress' label
  • If PR is ready for review, a reviewer has been added. (Don't use 'Assignees')
  • If this is an important user-facing change, PR or related issue has a 'changelog' label
  • If this includes an internal dependency change, a link to the diff is provided

Reviewer checklist

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

@MisRob MisRob added the TODO: needs review Waiting for review label Jan 22, 2024
@MisRob MisRob requested a review from marcellamaki January 22, 2024 06:06
@@ -24,7 +24,7 @@
"js-cookie": "^3.0.5",
"knuth-shuffle-seeded": "^1.0.6",
"kolibri-constants": "0.2.0",
"kolibri-design-system": "https://github.com/learningequality/kolibri-design-system#v2.0.0-beta1",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know why beta was here instead of 0ed2f274b1bc3808218a4d3f526c181b96b32c6d. I assume it might be caused by a release -> develop merge conflict. According to the yarn.lock it seems that 0ed2f274b1bc3808218a4d3f526c181b96b32c6d was the actually installed version so should be okay.

@MisRob
Copy link
Member Author

MisRob commented Feb 14, 2024

Closing in favor of #11873

@MisRob MisRob closed this Feb 14, 2024
@MisRob MisRob deleted the upgrade-kds-latest branch February 29, 2024 08:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant