Automate changelog from release notes

Props to @johnbillion for the work he had done on https://github.com/johnbillion/user-switching that this work is very minorly tweaked from.

- The README.md contains a HTML comment as a placeholder.
- During the deploy workflow (which happens when a non-pre-release release is made from a tag), it connects to the GitHub API, and pulls down previous release notes, removes any pre-release entries, sorts them into order, and loops through to create a string of headings and release notes.
- This then replaces the HTML comment in the README.md file.

Now instead of maintaining release notes in a CHANGELOG file or in the README, AND also in the GitHub release notes, it's now a single location (GitHub release notes).

The `changelog.js` workflow script can also be called locally, and this will do a one-time replacement of the HTML comment (for testing or removal of this automation). It needs a GitHub personal access token, and then call:

  TOKEN=... GITHUB_REPOSITORY='Automattic/ad-code-manager' node .github/workflows/changelog.js

Author: GaryJones

.github/workflows/changelog.js

@@ -0,0 +1,52 @@
+// Replaces the `<!-- changelog -->` comment in the README.md with the release notes from GitHub.
+// Usage locally:
+//   TOKEN=... GITHUB_REPOSITORY='Automattic/ad-code-manager' node .github/workflows/changelog.js
+// Where TOKEN is a personal GitHub token that has access to the repo: https://github.com/settings/tokens
+// In a GitHub Workflow, TOKEN can be passed the special ${{ secrets.GITHUB_TOKEN }} token.
+
+const github = require('@actions/github');
+const semver = require('semver');
+const replace = require('replace-in-file');
+
+const filename = process.argv[2] || 'README.md';
+const myToken = process.env.TOKEN;
+
+async function run() {
+	const api = new github.GitHub(myToken);
+
+	const { data: releases } = await api.repos.listReleases( github.context.repo );
+
+	let published = releases.filter( release =>
+		! release.draft && ! release.prerelease
+	);
+
+	let sorted = published.sort( ( a, b ) =>
+		semver.rcompare( semver.coerce( a.tag_name ), semver.coerce( b.tag_name ) )
+	);
+
+	let changelog = sorted.reduce( ( changelog, release ) =>
+			`${changelog}
+
+### ${release.tag_name}
+
+${release.body}`
+		, '## Changelog' );
+
+	try {
+		const results = await replace( {
+			files: filename,
+			from: '<!-- changelog -->',
+			to: changelog,
+		} );
+
+		if ( results.filter( result => ! result.hasChanged ).length ) {
+			console.error( 'No replacements made' );
+			process.exitCode = 1;
+		}
+	} catch( exception ) {
+		console.error( exception );
+		process.exitCode = 1;
+	}
+}
+
+run();

.github/workflows/deploy.yml

@@ -7,7 +7,19 @@ jobs:
     name: New tag
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v3
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Configure NPM cache
+        uses: c-hive/gha-npm-cache@v1
+
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Populate Changelog
+        run: node .github/workflows/changelog.js
+        env:
+          TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: WordPress Plugin Deploy
         uses: 10up/action-wordpress-plugin-deploy@stable

.gitignore

@@ -1,3 +1,4 @@
 /.phpunit.result.cache
 /composer.lock
+/package-lock.json
 /vendor

package.json

@@ -0,0 +1,13 @@
+{
+	"name": "ad-code-manager",
+	"version": "0.5.0",
+	"description": "Easy ad code management.",
+	"license": "GPL-2.0-or-later",
+	"author": "Automattic",
+	"repository": "automattic/ad-code-manager",
+	"devDependencies": {
+		"@actions/github": "^2",
+		"replace-in-file": "^5",
+		"semver": "^7"
+	}
+}

readme.md

@@ -551,85 +551,4 @@ function my_acm_ad_code_args( $args ) {
 }
 ~~~
 
-## Upgrade Notice
-
-### 0.5
-DFP Async provider now supports multiple sizes. [Check out this snippet to see implementation](http://pastie.org/10422227)
-
-### 0.4
-Easier, streamlined configuration for Doubleclick for Publishers Async and Google AdSense.
-
-### 0.3
-Conditional operator logic can be set on an ad code by ad code basis. Couple of bug fixes.
-
-### 0.2.3
-The filter acm_provider_columns is removed in favor of acm_ad_code_args (see acm_ad_code_args )
-
-### 0.2.2
-Incorporated a new provider for Google AdSense and added bulk delete action for the WP List Table.
-
-### 0.2.1
-Flush the cache when adding or deleting ad codes, and set priority of 10 when a priority doesn't exist for an ad code.
-
-## Changelog
-
-### 0.5 (Sep 15, 2015)
-* Added support for flex sized DFP Async ads (see upgrade notice)
-* Added robots.txt entries for provider's crawlers
-* Bug fix: Prevent global `$post` polution if ad code is getting rendered inside a loop
-* New Italian translation courtesy of [sniperwolf](https://github.com/sniperwolf)
-* Using PHP5 constructs when initializing the widget
-
-### 0.4.1 (Apr. 27, 2013)
-* Disabled rendering of ads on preview to avoid crawling errors. Thanks [Paul Gibbs](https://github.com/paulgibbs)
-* Bug fix: Corrected "medium rectangle" ad size for DFP Async Provider. Thanks [Marco](https://github.com/NRG-R9T)
-
-### 0.4 (Mar. 19, 2013)
-* Streamlined configuration for Doubleclick for Publishers Async and Google AdSense
-* Faster, cleaner JavaScript thanks to [Jeremy Felt](https://github.com/jeremyfelt) and [Carl Danley](https://github.com/carldanley)
-* New filter 'acm_output_html_after_tokens_processed' for rare cases where you might want to filter html after the tokens are processed
-
-### 0.3 (October 25, 2012)
-* Conditional operator logic can be set on an ad code by ad code basis. Thanks [jtsternberg](https://github.com/jtsternberg) for the pull request!
-* Bug fix: If an ad tag doesn't need a URL, ignore the whitelist check
-* Bug fix: Make sure that all providers list tables call parent::get_columns to avoid conflicts with filters.
-* Coding standards cleanup
-
-### 0.2.3 (June 25,2012)
-* Allow columns to be optional when creating and editing ad codes, introduced new filter acm_ad_code_args
-* Remove acm_provider_columns filter
-
-### 0.2.2 (June 5, 2012)
-* New Google Ad Sense provider courtesy of [Erick Hitter](http://www.ethitter.com/)
-* Bulk delete action added for the WP List Table of ad codes. Delete more ad codes in one go
-* New 'acm_register_provider_slug' for registering a provider that's included outside the plugin (e.g. a theme)
-* Bug fix: Instantiate the WP List Table on the view, instead of on admin_init, to reduce conflicts with other list tables
-
-### 0.2.1 (May 14, 2012)
-* Flush the cache whenever an ad code is created or deleted so you don't have to wait for a timeout with persistent cache
-* Bug fix: Default to priority 10 when querying for ad codes if there is no priority set
-
-### 0.2 (May 7, 2012)
-* UI reworked from the ground up to look and work much more like the WordPress admin (using WP List Table)
-* Abstracted ad network logic, so users can integrate other ad networks. Pull requests to add support to the plugin are always welcome
-* Added in-plugin contextual help
-* Implemented priority for ad code (allows to workaround ad code conflicts if any)
-* Implemented the [acm-tag] shortcode
-* Implemented ACM Widget. Thanks to [Justin Sternburg](https://github.com/jtsternberg) at WebDevStudios for the contribution
-* Initial loading of the ad codes is now cached using object cache
-* Bug fix: Enable using ad codes with empty filters using a filter
-* Bug fix: Setting the logical operator from OR to AND did not seem to result in the expected behaviour for displaying ads
-* Bug fix: Remove logical operator check when a conditional for an ad code is empty
-
-### 0.1.3 (February 13, 2012)
-* UI cleanup for the admin, including styling and information on applying conditionals
-
-### 0.1.2 (February 9, 2012)
-* Readme with full description and examples
-* Bug fix: Save the proper value when editing actions
-
-### 0.1.1
-* Bug fix release
-
-### 0.1
-* Initial release
+<!-- changelog -->