Skip to content

Commit ee341bd

Browse files
authored
Merge pull request #70 from INN/68-tag-1.3.2.3
Tag version 1.3.2.3
2 parents eaf0d1b + c09cf49 commit ee341bd

File tree

5 files changed

+93
-11
lines changed

5 files changed

+93
-11
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@ This plugin allows the use of NPR's [Pym.js](http://blog.apps.npr.org/pym.js/) r
55
For detailed examples, ➡️ [read the docs!](./docs/) ⬅️
66

77
For a detailed changelog, [read readme.txt](./readme.txt)!
8+
9+
For the most-recent release, [see the list of releases](https://github.com/INN/pym-shortcode/releases).

docs/maintainer-notes.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Notes for Plugin maintainers
22

3-
### Updating Pym.js
3+
## Updating Pym.js
44

55
`js/pym.v1.min.js` in this plugin should be kept up-to-date with the current version of https://pym.nprapps.org/pym.v1.min.js.
66

@@ -13,7 +13,7 @@ To update:
1313

1414
NPR Visuals Team's [stated intention](https://github.com/nprapps/pym.js/tree/master#versioning) is that versions of `Pym.js` will be backwards-compatible for `0.x` and `0.0.x` releases, so we can copy those in directly. When a `x.0.0` release comes around, we'll need to figure out a plan for that. See discussion in https://github.com/INN/pym-shortcode/issues/12
1515

16-
### Updating the plugin
16+
## Updating the plugin
1717

1818
The plugin's `A.B.C` version number should match the version number of the bundled copy of `Pym.js`. We started doing this in plugin release 1.1.2.
1919

@@ -28,14 +28,26 @@ The plugin's [version history](https://github.com/INN/pym-shortcode/releases) lo
2828
- 1.3.2
2929
- 1.3.2.1: Gutenberg and settings page
3030
- 1.3.2.2: WordPress 5.0 support
31+
- 1.3.2.3: AMP support
3132

32-
### Testing before release
33+
## Release checklist
34+
35+
See [release-checklist.md](./release-checklist.md) for the full list.
36+
37+
## Testing before release
38+
39+
You should make a copy of this document to keep track of checking off the checkboxes. A Github comment is a fine place to do that, as in https://github.com/INN/pym-shortcode/issues/68#issuecomment-593634311.
3340

3441
See also https://github.com/INN/docs/blob/master/projects/wordpress-plugins/release.sh.md
3542

43+
Run the following tests both with and without [the AMP plugin](https://wordpress.org/plugins/amp/) activated:
44+
- [ ] with
45+
- [ ] without
46+
3647
Plugin settings:
3748

38-
- [ ] Does the plugin settings page work?
49+
- [ ] Does the plugin settings page work? `/wp-admin/options-general.php?page=pym-embed-settings`
50+
- [ ] Does the plugin info page work? `/wp-admin/tools.php?page=pym-embeds-info`
3951

4052
Shortcode tests:
4153

docs/release-checklist.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
Drawing from Largo's 0.7.0 release checklist issue https://github.com/INN/largo/issues/1798, the SCAMP 0.3 tag checklist https://github.com/INN/doubleclick-for-wp/issues/83, https://github.com/INN/republication-tracker-tool/issues/63, and other issues:
2+
3+
4+
## Team Prep Work
5+
6+
- [ ] check for [upstream updates to `release.sh` in INN/docs](https://github.com/INN/docs/blob/master/projects/wordpress-plugins/release.sh.md) and copy them into this plugin
7+
- [ ] write release announcement
8+
- [ ] GitHub release drafted
9+
- can be copied from `changelog.md`
10+
- [ ] includes encouragement to say hi if you're using the plugin. (This fulfills the "who's using our stuff?" goal in https://github.com/INN/largo/issues/1495)
11+
- [ ] labs.inn.org blog post written and saved as draft, based on changelog
12+
- [ ] MailChimp campaign for Largo User mailing list drafted: https://github.com/INN/largo/issues/1796
13+
- [ ] identify non-Github documentation for this plugin
14+
- [ ] note the location of that documentation
15+
- [ ] update outside documentation for this plugin
16+
- [ ] https://support.inn.org/article/100-pym-shortcode
17+
- [ ] any other known doc
18+
19+
## Before merging
20+
21+
The owner of the release needs to complete the following steps **BEFORE** merging the version-bump branch and tagging the release:
22+
23+
- [ ] resolve all secret issues, private issues, or issues with the plugin that are otherwise documented outside of this public repository
24+
- [ ] resolve all GitHub maintainer security advisories: [merge](https://help.github.com/en/articles/collaborating-in-a-temporary-private-fork-to-resolve-a-security-vulnerability) and [publish](https://help.github.com/en/articles/publishing-a-maintainer-security-advisory).
25+
- [ ] update and sort the changelog
26+
- [ ] make sure changelog has all items from this release, and all PRs and issues are linked
27+
- [ ] check that ordering and grouping of items is logical.
28+
- [ ] New features list
29+
- [ ] Dev-facing updates
30+
- [ ] Bugfixes
31+
- [ ] Potentially breaking changes and upgrade notices
32+
- [ ] Which versions of PHP was this tested against? ([why](https://secure.helpscout.net/conversation/963170317/4444/)) List the PHP versions that we're sure of and that WordPress supports. (See https://github.com/INN/largo/issues/1801)
33+
- [ ] update description
34+
- [ ] in readme.txt
35+
- [ ] in plugin description comment
36+
- [ ] bump version number
37+
- [ ] in readme.txt
38+
- [ ] in pym-shortcode.php
39+
- [ ] in readme.md
40+
- [ ] in docs/maintainer-notes.md
41+
- [ ] testing as described in https://github.com/INN/pym-shortcode/blob/master/docs/maintainer-notes.md
42+
43+
## Release process
44+
45+
- [ ] bump version number
46+
- [ ] tag and push to github
47+
- [ ] [release.sh](https://github.com/INN/docs/blob/master/projects/wordpress-plugins/release.sh.md)
48+
- [ ] publish release in GitHub
49+
- [ ] close milestone
50+
51+
## After release is published
52+
53+
- [ ] update plugins on our sites (inndev? ccs?)
54+
- [ ] publish update announcement blog post
55+
- [ ] tweet announcement and schedule 2-5 for the next 7 days (via TweetDeck, HootSuite, or similar) with simple download prompt or tweets detailing new features, like "Newsroom Staff Pages should be clean and useful. We think so too. See Largo 0.X's new...." Make sure these tweets get cross-tweeted between INN accounts.
56+
- [ ] add to Nerd Alert for following week
57+
- [ ] create the release ticket for the next milestone from this one
58+
- [ ] prune stale and merged branches
59+
- [ ] notify maintainers of related plugins: News Project, WP AMP, Amplify

pym-shortcode.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
/*
33
Plugin Name: Pym.js Embeds
44
Plugin URI: https://github.com/INN/pym-shortcode
5-
Description: A WordPress solution to embed iframes that are responsive horizontally and vertically using the NPR Visuals Team's `Pym.js`.
6-
Version: 1.3.2.2
5+
Description: A WordPress block and shortcode for embedding iframes that are responsive horizontally and vertically using the NPR Visuals Team's `Pym.js`.
6+
Version: 1.3.2.3
77
Author: INN Labs
88
Author URI: http://labs.inn.org/
99
License: GPL Version 2 or later
@@ -22,7 +22,7 @@
2222
* @return string The plugin version number
2323
*/
2424
function pym_plugin_version() {
25-
return '1.3.2.1';
25+
return '1.3.2.3';
2626
}
2727

2828
$includes = array(

readme.txt

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,19 @@ Donate link: https://inn.org/donate
44
Tags: shortcode, iframe, javascript, embeds, responsive, pym, NPR
55
Requires at least: 3.0.1
66
Requires PHP: 5.3
7-
Tested up to: 5.0-beta3
8-
Stable tag: 1.3.2.2
7+
Tested up to: 5.3.2
8+
Stable tag: 1.3.2.3
99
License: GPLv2 or later
1010
License URI: http://www.gnu.org/licenses/gpl-2.0.html
1111

12-
A WordPress solution to embed iframes that are responsive horizontally and vertically using the NPR Visuals Team's `Pym.js`.
12+
A WordPress block and shortcode for embedding iframes that are responsive horizontally and vertically, using the NPR Visuals Team's `Pym.js`. Now with AMP compatibility!
1313

1414
== Description ==
1515

1616
Pym.js Embeds provides shortcode and Gutenberg block wrappers for embedding responsive iframes using [Pym.js](http://blog.apps.npr.org/pym.js/), developed by the NPR Visuals Team. Embedded content resizes vertically to match its container's width.
1717

18+
AMP compatibility is provided by the [official AMP plugin](https://wordpress.org/plugins/amp/).
19+
1820
== Installation ==
1921

2022
1. In the WordPress Dashboard go to **Plugins**, then click the **Add Plugins** button and search the WordPress Plugins Directory for Pym.js Embeds. Alternatively, you can download the zip file from this Github repo and upload it manually to your WordPress site.
@@ -48,9 +50,16 @@ Mobile view of the WordPress post with the NPR embed using Pym.js Shortcode:
4850

4951
== Changelog ==
5052

51-
= unreleased =
53+
= 1.3.2.3 =
54+
55+
New features:
56+
57+
- Adds compatibility with [the official WordPress AMP Plugin](https://wordpress.org/plugins/amp/). On AMP endpoints, markup for Pym.js-based embeds is converted to `amp-iframe` tags. If you're not using the AMP Plugin, your site won't be affected. And if you're not viewing a page on an AMP endpoint, the page won't be affected. PR [#62](https://github.com/INN/pym-shortcode/pull/62) by Claudiu Lodromanean, [originally for Automattic's Newspack](https://github.com/Automattic/newspack-plugin/pull/276).
58+
59+
Other updates:
5260

5361
- Adds credit to GitHub user [eidietrich](https://github.com/eidietrich) for [PR #55](https://github.com/INN/pym-shortcode/pull/55) in the 1.3.2.2 release notes.
62+
- Fixes a 'nwesroom' typo. [PR #66](https://github.com/INN/pym-shortcode/pull/66) for issue [#65](https://github.com/INN/pym-shortcode/issues/65).
5463

5564
= 1.3.2.2 =
5665

0 commit comments

Comments
 (0)