Skip to content

Commit

Permalink
lazy-images: Mark package as abandoned
Browse files Browse the repository at this point in the history
WordPress Core has been outputting the necessary attributes for
browser-native lazy image loading for some time now, and it conflicts
with the new Interactivity API added by Gutenberg in 16.6. We've removed
use of it from both Jetpack and Boost. Let's finish the job by marking
it as deprecated, and then we can do a final release and remove it from
the monorepo.
  • Loading branch information
anomiex committed Jul 23, 2024
1 parent 4c6c1d6 commit b316888
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/monorepo.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,8 +125,8 @@ We use `composer.json` to hold metadata about projects. Much of our generic tool
* `.extra.autotagger`: Set truthy to enable automatic release-version tagging in the mirror repo. See [Mirror repositories > Autotagger](#autotagger) for details.
* `.extra.changelogger`: Configuration object for [Changelogger](#jetpack-changelogger). See [its documentation](https://github.com/Automattic/jetpack-changelogger#configuration) for details.
* `.extra.changelogger-default-type`: Certain of our tools automatically create Changelogger change entries. This is the value to use for `--type` when doing so. Default type is `changed`.
* `.extra.dependencies.build`: This optional array specifies the "slugs" of any within-monorepo build dependencies that can't otherwise be inferred. The "slug" consists of the two levels of directory under `projects/`, e.g. `plugins/jetpack` or `packages/lazy-images`.
* `.extra.dependencies.test`: This optional array specifies the "slugs" of any within-monorepo testing dependencies that can't otherwise be inferred. The "slug" consists of the two levels of directory under `projects/`, e.g. `plugins/jetpack` or `packages/lazy-images`. See [Testing](#testing) for details.
* `.extra.dependencies.build`: This optional array specifies the "slugs" of any within-monorepo build dependencies that can't otherwise be inferred. The "slug" consists of the two levels of directory under `projects/`, e.g. `plugins/jetpack` or `packages/changelogger`.
* `.extra.dependencies.test`: This optional array specifies the "slugs" of any within-monorepo testing dependencies that can't otherwise be inferred. The "slug" consists of the two levels of directory under `projects/`, e.g. `plugins/jetpack` or `packages/changelogger`. See [Testing](#testing) for details.
* `.extra.dependencies.test-only`: This optional array specifies the "slugs" of any within-monorepo dependencies that are only used for testing and/or static analysis and should be ignored otherwise when analyzing intra-monorepo dependencies.
* `.extra.dev-releases`: Indicate that the plugin will have developer alpha releases. Instead of the mirror repositories showing "VER-alpha", they'll start at "VER-a.0" and you can use the `-a` flag to the release tooling to release "VER-a.1".
* `.extra.mirror-repo`: This specifies the name of the GitHub mirror repo, i.e. the "Automattic/jetpack-_something_" in "<span>https://</span>github.com/Automattic/jetpack-_something_".
Expand Down
3 changes: 3 additions & 0 deletions projects/packages/lazy-images/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

Speed up your site and create a smoother viewing experience by loading images as visitors scroll down the screen, instead of all at once.

> [!CAUTION]
> This package is abandoned. WordPress Core now uses browsers' native lazy loading, and the code in here conflicts with the Interactivity API added in Gutenberg 16.6.
## Usage

```php
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Significance: patch
Type: deprecated

Mark package as abandoned.
3 changes: 2 additions & 1 deletion projects/packages/lazy-images/composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -64,5 +64,6 @@
"allow-plugins": {
"roots/wordpress-core-installer": true
}
}
},
"abandoned": true
}

0 comments on commit b316888

Please sign in to comment.