Skip to content

Commit

Permalink
Merge remote-tracking branch 'google/master' into patch-1
Browse files Browse the repository at this point in the history
  • Loading branch information
szepeviktor committed Feb 12, 2020
2 parents a4b129a + 78e8e5b commit 13a667f
Show file tree
Hide file tree
Showing 8 changed files with 52 additions and 50 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ just a few small guidelines you need to follow.
To start, clone this repository into any WordPress install being used for development:

```bash
git clone [email protected]:xwp/pwa-wp.git wp-content/plugins/pwa
git clone [email protected]:GoogleChromeLabs/pwa-wp.git wp-content/plugins/pwa
cd wp-content/plugins/pwa
npm install
```
Expand Down Expand Up @@ -61,7 +61,7 @@ Contributors who want to make a new release, follow these steps:
2. Bump plugin versions in `pwa.php` (×2: the metadata block in the header and also the `PWA_VERSION` constant), and the `Stable tag` in `readme.txt`.
3. Add changelog entry to readme.
4. Draft blog post about the new release, presumably on Make/Core.
5. [Draft new release](https://github.com/xwp/pwa-wp/releases/new) on GitHub targeting the release branch, with the new plugin version as the tag and release title. Attaching the `pwa.zip` build to the release. Include link to changelog in release tag.
5. [Draft new release](https://github.com/GoogleChromeLabs/pwa-wp/releases/new) on GitHub targeting the release branch, with the new plugin version as the tag and release title. Attaching the `pwa.zip` build to the release. Include link to changelog in release tag.
6. Run `npm run deploy` to to commit the plugin to WordPress.org.
7. Confirm the release is available on WordPress.org; try installing it on a WordPress install and confirm it works.
8. Publish GitHub release.
Expand Down
6 changes: 3 additions & 3 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "xwp/pwa-wp",
"name": "GoogleChromeLabs/pwa-wp",
"description": "WordPress plugin for adding PWA support.",
"homepage": "https://github.com/xwp/pwa-wp",
"homepage": "https://github.com/GoogleChromeLabs/pwa-wp",
"type": "wordpress-plugin",
"license": "GPL-2.0-or-later",
"require": {
Expand All @@ -11,6 +11,6 @@
"dealerdirect/phpcodesniffer-composer-installer": "0.5.0",
"phpcompatibility/phpcompatibility-wp": "2.0.0",
"wp-coding-standards/wpcs": "2.1.1",
"xwp/wp-dev-lib": "1.4.0"
"xwp/wp-dev-lib": "1.5.0"
}
}
56 changes: 29 additions & 27 deletions composer.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"name": "pwa-wp",
"title": "PWA feature plugin for WordPress Core",
"homepage": "https://github.com/xwp/pwa-wp",
"homepage": "https://github.com/GoogleChromeLabs/pwa-wp",
"repository": {
"type": "git",
"url": "https://github.com/xwp/pwa-wp.git"
"url": "https://github.com/GoogleChromeLabs/pwa-wp.git"
},
"license": "GPL-2.0-or-later",
"private": true,
Expand Down
4 changes: 2 additions & 2 deletions pwa.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@
*
* @wordpress-plugin
* Plugin Name: PWA
* Plugin URI: https://github.com/xwp/pwa-wp
* Plugin URI: https://github.com/GoogleChromeLabs/pwa-wp
* Description: Feature plugin to bring Progressive Web App (PWA) capabilities to Core
* Version: 0.4.0-alpha
* Author: PWA Plugin Contributors
* Author URI: https://github.com/xwp/pwa-wp/graphs/contributors
* Author URI: https://github.com/GoogleChromeLabs/pwa-wp/graphs/contributors
* Text Domain: pwa
* License: GPL-2.0+
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt
Expand Down
14 changes: 7 additions & 7 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@
![Banner](wp-assets/banner-1544x500.png)
WordPress feature plugin to bring Progressive Web App (PWA) capabilities to Core

**Contributors:** [xwp](https://profiles.wordpress.org/xwp), [google](https://profiles.wordpress.org/google), [automattic](https://profiles.wordpress.org/automattic)
**Contributors:** [google](https://profiles.wordpress.org/google), [xwp](https://profiles.wordpress.org/xwp)
**Tags:** [pwa](https://wordpress.org/plugins/tags/pwa), [progressive web apps](https://wordpress.org/plugins/tags/progressive-web-apps), [service workers](https://wordpress.org/plugins/tags/service-workers), [web app manifest](https://wordpress.org/plugins/tags/web-app-manifest), [https](https://wordpress.org/plugins/tags/https)
**Requires at least:** 5.2
**Tested up to:** 5.3
**Stable tag:** 0.3.0
**License:** [GPLv2 or later](http://www.gnu.org/licenses/gpl-2.0.html)
**Requires PHP:** 5.6

[![Build Status](https://travis-ci.org/xwp/pwa-wp.svg?branch=master)](https://travis-ci.org/xwp/pwa-wp) [![Built with Grunt](https://gruntjs.com/cdn/builtwith.svg)](http://gruntjs.com)
[![Build Status](https://travis-ci.org/GoogleChromeLabs/pwa-wp.svg?branch=master)](https://travis-ci.org/GoogleChromeLabs/pwa-wp) [![Built with Grunt](https://gruntjs.com/cdn/builtwith.svg)](http://gruntjs.com)

## Description ##

Expand Down Expand Up @@ -40,7 +40,7 @@ This plugin serves as a place to implement support for these in WordPress with t

☞ Please note that this feature plugin is _not_ intended to obsolete the other plugins and themes which turn WordPress sites into PWAs. Rather, this plugin is intended to provide the PWA building blocks and coordination mechanism for these themes and plugins to not reinvent the wheel and also to not conflict with each other. For example, a theme that implements the app shell model should be able to extend the core service worker while a plugin that provides push notifications should be able to do the same. Themes and plugins no longer should have to each create a service worker on their own, something which is inherently problematic because only one service worker can be active at a time: only one service worker can win. If you are developing a plugin or theme that includes a service worker, consider relying on this PWA plugin, or at least only use the built-in implementation as a fallback for when the PWA plugin is not available.

**Development of this plugin is done [on GitHub](https://github.com/xwp/pwa-wp). Pull requests welcome. Please see [issues](https://github.com/xwp/pwa-wp/issues) reported there before going to the [plugin forum](https://wordpress.org/support/plugin/pwa).**
**Development of this plugin is done [on GitHub](https://github.com/GoogleChromeLabs/pwa-wp). Pull requests welcome. Please see [issues](https://github.com/GoogleChromeLabs/pwa-wp/issues) reported there before going to the [plugin forum](https://wordpress.org/support/plugin/pwa).**
### Web App Manifest ###
As noted in a [Google guide](https://developers.google.com/web/fundamentals/web-app-manifest/):

Expand Down Expand Up @@ -91,7 +91,7 @@ The manifest is populated with default values including:

There is a `web_app_manifest` filter which is passed the above array so that plugins and themes can customize the manifest.

See [labeled GitHub issues](https://github.com/xwp/pwa-wp/issues?q=label%3Aweb-app-manifest) and see WordPress core tracking ticket [#43328](https://core.trac.wordpress.org/ticket/43328).
See [labeled GitHub issues](https://github.com/GoogleChromeLabs/pwa-wp/issues?q=label%3Aweb-app-manifest) and see WordPress core tracking ticket [#43328](https://core.trac.wordpress.org/ticket/43328).

### Service Workers ###
As noted in a [Google primer](https://developers.google.com/web/fundamentals/primers/service-workers/):
Expand Down Expand Up @@ -150,7 +150,7 @@ add_action( 'wp_front_service_worker', 'register_baz_service_worker_script' );
add_action( 'wp_admin_service_worker', 'register_baz_service_worker_script' );
```

See [labeled GitHub issues](https://github.com/xwp/pwa-wp/issues?q=label%3Aservice-workers) and see WordPress core tracking ticket [#36995](https://core.trac.wordpress.org/ticket/36995).
See [labeled GitHub issues](https://github.com/GoogleChromeLabs/pwa-wp/issues?q=label%3Aservice-workers) and see WordPress core tracking ticket [#36995](https://core.trac.wordpress.org/ticket/36995).

### Integrations ###
The plugin bundles several experimental integrations that are kept separate from the service worker core code. These integrations act as examples and proof-of-concept to achieve certain goals. While all of them are generally applicable and recommended to truly benefit from service workers, they are not crucial for the core API.
Expand Down Expand Up @@ -308,7 +308,7 @@ Here is a list of all available actions and filters added by the feature plugin.
### HTTPS ###
HTTPS is a prerequisite for progressive web apps. A service worker is only able to be installed on sites that are served as HTTPS. For this reason core's support for HTTPS needs to be further improved, continuing the great progress made over the past few years.

At the moment the plugin provides an API to detection of whether a site supports HTTPS. Building on that it's intended that this can then be used to present a user with an opt-in to switch over to HTTPS, which will also then need to include support for rewriting URLs from HTTP to HTTPS. See [labeled GitHub issues](https://github.com/xwp/pwa-wp/issues?q=label%3Ahttps) and see WordPress core tracking ticket [#28521](https://core.trac.wordpress.org/ticket/28521).
At the moment the plugin provides an API to detection of whether a site supports HTTPS. Building on that it's intended that this can then be used to present a user with an opt-in to switch over to HTTPS, which will also then need to include support for rewriting URLs from HTTP to HTTPS. See [labeled GitHub issues](https://github.com/GoogleChromeLabs/pwa-wp/issues?q=label%3Ahttps) and see WordPress core tracking ticket [#28521](https://core.trac.wordpress.org/ticket/28521).

You can optionally add an [HSTS header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security) (HTTP `Strict-Transport-Security`). This indicates to the browser to only load the site with HTTPS, not HTTP.

Expand All @@ -334,5 +334,5 @@ Please see the [documentation](https://developer.mozilla.org/en-US/docs/Web/HTTP

## Changelog ##

For the plugin’s changelog, please see [the Releases page on GitHub](https://github.com/xwp/pwa-wp/releases).
For the plugin’s changelog, please see [the Releases page on GitHub](https://github.com/GoogleChromeLabs/pwa-wp/releases).

Loading

0 comments on commit 13a667f

Please sign in to comment.