Skip to content

Commit

Permalink
Merge pull request #70 from INN/68-tag-1.3.2.3
Browse files Browse the repository at this point in the history
Tag version 1.3.2.3
  • Loading branch information
benlk authored Mar 3, 2020
2 parents eaf0d1b + c09cf49 commit ee341bd
Show file tree
Hide file tree
Showing 5 changed files with 93 additions and 11 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@ This plugin allows the use of NPR's [Pym.js](http://blog.apps.npr.org/pym.js/) r
For detailed examples, ➡️ [read the docs!](./docs/) ⬅️

For a detailed changelog, [read readme.txt](./readme.txt)!

For the most-recent release, [see the list of releases](https://github.com/INN/pym-shortcode/releases).
20 changes: 16 additions & 4 deletions docs/maintainer-notes.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Notes for Plugin maintainers

### Updating Pym.js
## Updating Pym.js

`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.

Expand All @@ -13,7 +13,7 @@ To update:

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

### Updating the plugin
## Updating the plugin

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.

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

### Testing before release
## Release checklist

See [release-checklist.md](./release-checklist.md) for the full list.

## Testing before release

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.

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

Run the following tests both with and without [the AMP plugin](https://wordpress.org/plugins/amp/) activated:
- [ ] with
- [ ] without

Plugin settings:

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

Shortcode tests:

Expand Down
59 changes: 59 additions & 0 deletions docs/release-checklist.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
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:


## Team Prep Work

- [ ] 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
- [ ] write release announcement
- [ ] GitHub release drafted
- can be copied from `changelog.md`
- [ ] 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)
- [ ] labs.inn.org blog post written and saved as draft, based on changelog
- [ ] MailChimp campaign for Largo User mailing list drafted: https://github.com/INN/largo/issues/1796
- [ ] identify non-Github documentation for this plugin
- [ ] note the location of that documentation
- [ ] update outside documentation for this plugin
- [ ] https://support.inn.org/article/100-pym-shortcode
- [ ] any other known doc

## Before merging

The owner of the release needs to complete the following steps **BEFORE** merging the version-bump branch and tagging the release:

- [ ] resolve all secret issues, private issues, or issues with the plugin that are otherwise documented outside of this public repository
- [ ] 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).
- [ ] update and sort the changelog
- [ ] make sure changelog has all items from this release, and all PRs and issues are linked
- [ ] check that ordering and grouping of items is logical.
- [ ] New features list
- [ ] Dev-facing updates
- [ ] Bugfixes
- [ ] Potentially breaking changes and upgrade notices
- [ ] 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)
- [ ] update description
- [ ] in readme.txt
- [ ] in plugin description comment
- [ ] bump version number
- [ ] in readme.txt
- [ ] in pym-shortcode.php
- [ ] in readme.md
- [ ] in docs/maintainer-notes.md
- [ ] testing as described in https://github.com/INN/pym-shortcode/blob/master/docs/maintainer-notes.md

## Release process

- [ ] bump version number
- [ ] tag and push to github
- [ ] [release.sh](https://github.com/INN/docs/blob/master/projects/wordpress-plugins/release.sh.md)
- [ ] publish release in GitHub
- [ ] close milestone

## After release is published

- [ ] update plugins on our sites (inndev? ccs?)
- [ ] publish update announcement blog post
- [ ] 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.
- [ ] add to Nerd Alert for following week
- [ ] create the release ticket for the next milestone from this one
- [ ] prune stale and merged branches
- [ ] notify maintainers of related plugins: News Project, WP AMP, Amplify
6 changes: 3 additions & 3 deletions pym-shortcode.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
/*
Plugin Name: Pym.js Embeds
Plugin URI: https://github.com/INN/pym-shortcode
Description: A WordPress solution to embed iframes that are responsive horizontally and vertically using the NPR Visuals Team's `Pym.js`.
Version: 1.3.2.2
Description: A WordPress block and shortcode for embedding iframes that are responsive horizontally and vertically using the NPR Visuals Team's `Pym.js`.
Version: 1.3.2.3
Author: INN Labs
Author URI: http://labs.inn.org/
License: GPL Version 2 or later
Expand All @@ -22,7 +22,7 @@
* @return string The plugin version number
*/
function pym_plugin_version() {
return '1.3.2.1';
return '1.3.2.3';
}

$includes = array(
Expand Down
17 changes: 13 additions & 4 deletions readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,19 @@ Donate link: https://inn.org/donate
Tags: shortcode, iframe, javascript, embeds, responsive, pym, NPR
Requires at least: 3.0.1
Requires PHP: 5.3
Tested up to: 5.0-beta3
Stable tag: 1.3.2.2
Tested up to: 5.3.2
Stable tag: 1.3.2.3
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

A WordPress solution to embed iframes that are responsive horizontally and vertically using the NPR Visuals Team's `Pym.js`.
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!

== Description ==

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.

AMP compatibility is provided by the [official AMP plugin](https://wordpress.org/plugins/amp/).

== Installation ==

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.
Expand Down Expand Up @@ -48,9 +50,16 @@ Mobile view of the WordPress post with the NPR embed using Pym.js Shortcode:

== Changelog ==

= unreleased =
= 1.3.2.3 =

New features:

- 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).

Other updates:

- 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.
- 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).

= 1.3.2.2 =

Expand Down

0 comments on commit ee341bd

Please sign in to comment.