umberto 4.2.4 → 4.2.6

package/CHANGELOG.md

@@ -1,6 +1,20 @@
 Changelog
 =========
 
+## [4.2.6](https://github.com/cksource/umberto/compare/v4.2.5...v4.2.6) (2024-08-12)
+
+### Bug fixes
+
+* Fixed the API dropdown lists (the "Properties", "Methods" and "Events" lists) to be rendered on top of the "See source" link. Closes [#1205](https://github.com/cksource/umberto/issues/1205). ([commit](https://github.com/cksource/umberto/commit/7bbb3d5fa4b46a6fe5df5887297e9225241829ba))
+
+
+## [4.2.5](https://github.com/cksource/umberto/compare/v4.2.4...v4.2.5) (2024-07-25)
+
+### Other changes
+
+* Fixed SASS deprecation warnings when compiling CSS files. Closes [#1200](https://github.com/cksource/umberto/issues/1200). ([commit](https://github.com/cksource/umberto/commit/5aa1aa949670f846dba02d94575a94b56a22179a))
+
+
 ## [4.2.4](https://github.com/cksource/umberto/compare/v4.2.3...v4.2.4) (2024-07-17)
 
 Internal changes only (updated dependencies, documentation, etc.).

package/README.md

@@ -688,28 +688,21 @@ E.g.
 	MAIN
 	```
 
-## Releasing package
+## Releasing the package
 
-### Changelog
+CircleCI automates the release process and can release both channels: stable (`X.Y.Z`) and pre-releases (`X.Y.Z-alpha.X`, etc.).
 
-Before starting the release process, you need to generate the changelog:
+Before you start, you need to prepare the changelog entries.
 
-```bash
-npm run changelog
-```
-
-### Publishing
+1. Make sure the `#master` branch is up-to-date: `git fetch && git checkout master && git pull`.
+1. Prepare a release branch: `git checkout -b release-[YYYYMMDD]` where `YYYYMMDD` is the current day.
+1. Generate the changelog entries: `yarn run changelog --branch release-[YYYYMMDD] [--from [GIT_TAG]]`.
+	* By default, the changelog generator uses the latest published tag as a starting point for collecting commits to process.
 
-After generating the changelog, you are able to release the package.
+	  The `--from` modifier option allows overriding the default behavior. It is required when preparing the changelog entries for the next stable release while the previous one was marked as a prerelease, e.g., `@alpha`.
 
-First, you need to bump the version:
-
-```bash
-npm run release:prepare-packages
-```
-
-After bumping the version, you can publish the changes:
-
-```bash
-npm run release:publish-packages
-```
+	  **Example**: Let's assume that the `v5.0.0-alpha.0` tag is our latest and that we want to release it on a stable channel. The `--from` modifier should be equal to `--from v4.0.0`.
+	* This task checks what changed in each package and bumps the version accordingly. It won't create a new changelog entry if nothing changes at all. If changes were irrelevant (e.g., only dependencies), it would make an "_internal changes_" entry.
+	* Scan the logs printed by the tool to search for errors (incorrect changelog entries). Incorrect entries (e.g., ones without the type) should be addressed. You may need to create entries for them manually. This is done directly in CHANGELOG.md (in the root directory). Make sure to verify the proposed version after you modify the changelog.
+1. Commit all changes and prepare a new pull request targeting the `#master` branch.
+1. Ping the `@ckeditor/ckeditor-5-devops` team to review the pull request and trigger the release process.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "umberto",
-  "version": "4.2.4",
+  "version": "4.2.6",
   "description": "CKSource Documentation builder",
   "main": "src/index.js",
   "files": [
@@ -20,7 +20,7 @@
     "@ckeditor/jsdoc-plugins": "^32.0.1",
     "babel-loader": "^8.2.5",
     "chalk": "^4.1.0",
-    "cheerio": "^1.0.0-rc.12",
+    "cheerio": "^1.0.0",
     "cpx": "^1.5.0",
     "del": "^6.1.1",
     "element-closest": "^3.0.2",

package/scripts/filter/after-post-render/fix-code-samples.js

@@ -5,7 +5,7 @@
 
 'use strict';
 
-const { default: cheerio } = require( 'cheerio' );
+const cheerio = require( 'cheerio' );
 
 const regexp = /(?<=>)utf8_encoded_content:([0-9,]+)(?=<\/code><\/pre>)/g;
 const textDecoder = new TextDecoder();

package/scripts/filter/after-post-render/insert-error-codes.js

@@ -5,7 +5,7 @@
 
 'use strict';
 
-const { default: cheerio } = require( 'cheerio' );
+const cheerio = require( 'cheerio' );
 const upath = require( 'upath' );
 
 /**

package/scripts/filter/after-post-render/validate-after-render.js

@@ -5,7 +5,7 @@
 
 'use strict';
 
-const { default: cheerio } = require( 'cheerio' );
+const cheerio = require( 'cheerio' );
 
 /**
  * Make sure each page has a title.

package/scripts/helper/u-split-to-title-and-content.js

@@ -5,7 +5,7 @@
 
 'use strict';
 
-const { default: cheerio } = require( 'cheerio' );
+const cheerio = require( 'cheerio' );
 
 hexo.extend.helper.register( 'uSplitToTitleAndContent', data => {
 	const $ = cheerio.load( data, null, false );

package/scripts/helper/u-toc.js

@@ -5,7 +5,7 @@
 
 'use strict';
 
-const { default: cheerio } = require( 'cheerio' );
+const cheerio = require( 'cheerio' );
 
 hexo.extend.helper.register( 'uToc', ( data, options = {} ) => {
 	const $ = cheerio.load( data, null, false );

package/src/api-builder/api-builder.js

@@ -7,7 +7,7 @@
 
 const upath = require( 'upath' );
 const fs = require( 'fs-extra' );
-const { default: cheerio } = require( 'cheerio' );
+const cheerio = require( 'cheerio' );
 const FileNameManager = require( './classes/file-name-manager' );
 const HtmlFile = require( './classes/html-file' );
 const DocDataFactory = require( './classes/doc-data-factory' );

package/src/api-builder/classes/description-parser.js

@@ -5,7 +5,7 @@
 
 'use strict';
 
-const { default: cheerio } = require( 'cheerio' );
+const cheerio = require( 'cheerio' );
 const splitLongname = require( '../../helpers/split-longname' );
 const chalk = require( 'chalk' );
 const macroReplacer = require( '../../tasks/macro-replacer' );
@@ -334,7 +334,7 @@ module.exports = class DescriptionParser {
 			const headerLevel = Number( item.name.slice( -1 ) );
 			const newHeaderLevel = headerLevel + decreaseLevel <= 6 ? headerLevel + decreaseLevel : 6;
 
-			return cheerio( `<h${ newHeaderLevel }></h${ newHeaderLevel }>` ).append( $( item ).html() );
+			return cheerio.load( `<h${ newHeaderLevel }></h${ newHeaderLevel }>` )( `h${ newHeaderLevel }` ).append( $( item ).html() );
 		} );
 
 		return $.html();

package/src/data-converter/converters/jsduck2umberto.js

@@ -5,7 +5,7 @@
 
 'use strict';
 
-const { default: cheerio } = require( 'cheerio' );
+const cheerio = require( 'cheerio' );
 const keyNameMap = {
 	tagname: {
 		name: 'kind',

package/src/sdk-builder/get-sdk-sources.js

@@ -8,7 +8,7 @@
 const fs = require( 'fs' );
 const upath = require( 'upath' );
 const glob = require( 'glob' );
-const { default: cheerio } = require( 'cheerio' );
+const cheerio = require( 'cheerio' );
 
 const SDK_SELECTOR = 'meta[name="sdk-samples"]';
 

package/themes/umberto/src/css/_api-props-filter.scss

@@ -2,6 +2,14 @@
 // For licensing, see LICENSE.md or http://ckeditor.com/license
 
 div.api-props-filter {
+	right: 0;
+	left: $u-sidebar-width;
+	padding-top: u-spacing( -1 );
+	margin-bottom: 0;
+	text-align: center;
+
+	@include u-sticky-filter;
+
 	h4 {
 		@include u-micro-header;
 	}
@@ -25,14 +33,6 @@ div.api-props-filter {
 		}
 	}
 
-	@include u-sticky-filter;
-
-	right: 0;
-	left: $u-sidebar-width;
-	padding-top: u-spacing( -1 );
-	margin-bottom: 0;
-	text-align: center;
-
 	&__inner {
 		text-align: left;
 		margin: 0 auto;

package/themes/umberto/src/css/_api-subheader.scss

@@ -8,15 +8,14 @@
 
 	.api-subheader {
 		display: flex;
+		justify-content: space-between;
+		align-items: center;
+		margin-bottom: 20px;
 
 		&.hidden-loading {
 			display: none;
 		}
 
-		justify-content: space-between;
-		align-items: center;
-		margin-bottom: 20px;
-
 		@include u-responsive-mobile {
 			flex-wrap: wrap;
 		}
@@ -91,7 +90,8 @@
 				min-width: 500px;
 				max-height: 50vh;
 
-				z-index: 1;
+				// Render the API dropdowns on top of the "See source" button.
+				z-index: 2;
 
 				li {
 					width: 50%;

package/themes/umberto/src/css/_api-tree.scss

@@ -46,6 +46,11 @@
 
 /* Public/Inherited/Mixed/Protected/Private/Deprecated Items filter. */
 .api-tree__filter {
+	text-align: center;
+	left: 0;
+	width: $u-sidebar-width;
+	border-right: 1px solid u-color( 'background-hue' );
+
 	@include u-sticky-filter;
 	@include u-unselectable;
 
@@ -53,11 +58,6 @@
 		display: none;
 	}
 
-	text-align: center;
-	left: 0;
-	width: $u-sidebar-width;
-	border-right: 1px solid u-color( 'background-hue' );
-
 	input {
 		display: none;
 	}

package/themes/umberto/src/css/_collapsinglist.scss

@@ -140,16 +140,16 @@ ul.collapsing-list {
 		}
 
 		h3 {
+			margin-bottom: 0;
+			padding-top: 0;
+			width: 100%;
+
 			@include u-baseline( 0 );
 
 			code {
 				font-weight: 400;
 			}
 
-			margin-bottom: 0;
-			padding-top: 0;
-			width: 100%;
-
 			&:first-of-type {
 				flex: 2;
 			}

package/themes/umberto/src/css/_tree.scss

@@ -8,11 +8,13 @@ Note: there are also dedicated styles for API Tree and Guides & SDK Tree.
 See: `_api-tree.scss` and `_guide-sdk-tree.scss`. */
 
 .tree {
-	@include u-unselectable;
+	list-style: none;
 
 	// Make sure the filter never floats over the tree.
 	padding-bottom: $u-line-height-base + em;
 
+	@include u-unselectable;
+
 	// Generate styles for tree levels recursively.
 	@include u-responsive-tablet-plus {
 		@include levels( 1, 1 );
@@ -22,8 +24,6 @@ See: `_api-tree.scss` and `_guide-sdk-tree.scss`. */
 		@include levels( 1, 0 );
 	}
 
-	list-style: none;
-
 	&.guide-tree {
 		opacity: 0; //prevents flickering when applying categories fold state
 	}