Build assets during the release #2486

felipeelia · 2021-12-03T19:35:38Z

Description of the Change

This PR removes the dist folder from the repo and builds JS and CSS files during the release workflow.

Although the 10up/action-wordpress-plugin-deploy action optionally generates a zip file, we don't want to publish Beta versions on WP.org. That is why we have a separate step for the zip generation.

Verification Process

As testing this in this repo without making an actual release is impossible, tests were done in my personal fork. Here is the latest test: https://github.com/felipeelia/ElasticPress/releases/tag/4.0.0-beta-1.3

Applicable Issues

Closes #2182

Changelog Entry

Changed: Minified JavaScript and CSS files are now built during the release process and are not versioned anymore. Props @felipeelia

So we can use it with rsync to generate a zip file

For better alignment with SemVer: https://semver.org/#spec-item-9

jeffpaul · 2021-12-06T18:51:40Z

CONTRIBUTING.md

@@ -39,11 +39,30 @@ The `develop` branch is the development branch which means it contains the next
 1. Test: While still on the `master` branch, test for functionality locally.
 1. Push: Push your `master` branch to GitHub (e.g. `git push origin master`).
 1. Release: Create a [new release](https://github.com/10up/elasticpress/releases/new), naming the tag and the release with the new version number, and targeting the `master` branch.  Paste the release changelog from `CHANGELOG.md` into the body of the release and include a link to the closed issues on the [milestone](https://github.com/10up/elasticpress/milestone/#?closed=1).
+1. Check the assets build action: After the release, GitHub should trigger an action to generate a zip with the plugin and attach it to the GitHub Release page.


May be worth linking on Check the assets build action to the specific action to make it easier for others following these instructions. Eg https://github.com/10up/ElasticPress/actions/workflows/push-deploy.yml

jeffpaul · 2021-12-06T18:53:06Z

CONTRIBUTING.md

+1. New files: Check to be sure any new files/paths that are unnecessary in the production version are included in `.gitattributes`.
+1. Merge: Merge the release branch/PR into the next version branch (`4.x.x`, for example).
+1. Test: Checkout the next version branch locally and build assets like the GitHub Action will do (see `.github/workflows/push-deploy.yml`)
+1. Release: Create a [new release](https://github.com/10up/elasticpress/releases/new), naming the tag and the release with the new version number, and targeting the next version branch branch.  Paste the release changelog from `CHANGELOG.md` into the body of the release and include a link to the closed issues on the [milestone](https://github.com/10up/elasticpress/milestone/#?closed=1). **ATTENTION**: The tag **needs** to contain the `beta` string, so the version is not released in WordPress.org.


Note that you could also create a pre-release instead of relying on the beta string in the tag name.

jeffpaul · 2021-12-06T18:53:26Z

CONTRIBUTING.md

+1. Merge: Merge the release branch/PR into the next version branch (`4.x.x`, for example).
+1. Test: Checkout the next version branch locally and build assets like the GitHub Action will do (see `.github/workflows/push-deploy.yml`)
+1. Release: Create a [new release](https://github.com/10up/elasticpress/releases/new), naming the tag and the release with the new version number, and targeting the next version branch branch.  Paste the release changelog from `CHANGELOG.md` into the body of the release and include a link to the closed issues on the [milestone](https://github.com/10up/elasticpress/milestone/#?closed=1). **ATTENTION**: The tag **needs** to contain the `beta` string, so the version is not released in WordPress.org.
+1. Check the assets build action: After the release, GitHub should trigger an action to generate a zip with the plugin and attach it to the GitHub Release page.


May be worth linking on Check the assets build action to the specific action to make it easier for others following these instructions. Eg https://github.com/10up/ElasticPress/actions/workflows/push-deploy.yml

jeffpaul · 2021-12-06T18:56:33Z

.github/workflows/push-deploy.yml

+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        upload_url: ${{ github.event.release.upload_url }}
+        asset_path: ${{ github.workspace }}/${{ env.SLUG }}.zip


Note that you could tweak this, see sample action workflow here: https://github.com/10up/action-wordpress-plugin-deploy#deploy-on-publishing-a-new-release-and-attach-a-zip-file-to-the-release

jeffpaul · 2021-12-06T18:58:13Z

Note that you could utilize the prereleased type instead of published or released to target your beta releases as well. See more on that here: 10up/action-wordpress-plugin-deploy#5 (comment)

jeffpaul

I left some comments throughout, none are blockers

felipeelia · 2021-12-06T20:11:05Z

@jeffpaul addressed most of your comments in the recent commits. Do you mind checking again? Tests in my fork worked fine.

jeffpaul · 2021-12-06T20:32:59Z

CONTRIBUTING.md

+1. New files: Check to be sure any new files/paths that are unnecessary in the production version are included in `.gitattributes`.
+1. Merge: Merge the release branch/PR into the next version branch (`4.x.x`, for example).
+1. Test: Checkout the next version branch locally and build assets like the GitHub Action will do (see `.github/workflows/push-deploy.yml`)
+1. Release: Create a [new release](https://github.com/10up/elasticpress/releases/new), naming the tag and the release with the new version number, and targeting the next version branch branch.  Paste the release changelog from `CHANGELOG.md` into the body of the release and include a link to the closed issues on the [milestone](https://github.com/10up/elasticpress/milestone/#?closed=1). **ATTENTION**: Make sure to check the `This is a pre-release` checkbox, so the release is not published on WordPress.org.


Since we're going the "pre-release" route, it might be better to change the copy of the link from new release to new pre-release to hopefully capture whoever is handling the release's attention in case they miss the note at the end of this step?

jeffpaul · 2021-12-06T20:34:46Z

elasticpress.php

@@ -3,7 +3,7 @@
 * Plugin Name:       ElasticPress
 * Plugin URI:        https://github.com/10up/ElasticPress
 * Description:       A fast and flexible search and query engine for WordPress.
- * Version:           4.0.0-beta-1
+ * Version:           4.0.0-beta.1


For what its worth, WP core uses "beta1" and not "beta-1" or "beta.1" in case we want to more closely mimic their numbering scheme?

jeffpaul

This should be interesting 🍿

jeffpaul

:rubber-stamp:

felipeelia and others added 6 commits December 3, 2021 13:47

Remove built assets from the repo

5321dae

Build assets during deployment

37828ae

Use .distignore instead of .gitignore

fd0648f

So we can use it with rsync to generate a zip file

Fix the Create ZIP step

f949e0d

Adjust zip content to have the elasticpress folder as root

22f1e4b

Create parent folders

9963ef1

felipeelia added the high priority label Dec 3, 2021

felipeelia added this to the 4.0.0 (beta 1) milestone Dec 3, 2021

felipeelia requested review from brandwaffle and jeffpaul December 3, 2021 19:35

felipeelia self-assigned this Dec 3, 2021

10upbot on GitHub added 3 commits December 5, 2021 19:12

Document Beta Release process

76ff43b

Change beta-1 to beta.1

cb44b6c

For better alignment with SemVer: https://semver.org/#spec-item-9

Fix Beta release instructions title

e272ae0

jeffpaul reviewed Dec 6, 2021

View reviewed changes

jeffpaul approved these changes Dec 6, 2021

View reviewed changes

10upbot on GitHub added 7 commits December 6, 2021 16:42

Link to action workflow

2cc58e8

Rely on action type instead of tag name

ef50b7c

debug

94f51b5

Try different approach for prerelease diff

b217377

remove debug

7079302

Adjust instructions

6170410

Merge branch '4.x.x' into chore/build-assets-for-release

b785128

jeffpaul reviewed Dec 6, 2021

View reviewed changes

jeffpaul approved these changes Dec 6, 2021

View reviewed changes

10upbot on GitHub added 2 commits December 6, 2021 17:44

adjust pre-release copy

91b4748

Pre-release instructions example

1fe2093

jeffpaul approved these changes Dec 6, 2021

View reviewed changes

felipeelia merged commit 4117ffc into 4.x.x Dec 6, 2021

felipeelia deleted the chore/build-assets-for-release branch December 6, 2021 21:10

felipeelia pushed a commit that referenced this pull request Dec 6, 2021

Add #2486 to the changelog

0d243bb

felipeelia mentioned this pull request Dec 6, 2021

Versioning built assets #2182

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Build assets during the release #2486

Build assets during the release #2486

felipeelia commented Dec 3, 2021 •

edited

Loading

jeffpaul Dec 6, 2021

jeffpaul Dec 6, 2021

jeffpaul Dec 6, 2021

jeffpaul Dec 6, 2021

jeffpaul commented Dec 6, 2021

jeffpaul left a comment

felipeelia commented Dec 6, 2021

jeffpaul Dec 6, 2021

jeffpaul Dec 6, 2021

jeffpaul left a comment

jeffpaul left a comment

Build assets during the release #2486

Build assets during the release #2486

Conversation

felipeelia commented Dec 3, 2021 • edited Loading

Description of the Change

Verification Process

Applicable Issues

Changelog Entry

jeffpaul Dec 6, 2021

Choose a reason for hiding this comment

jeffpaul Dec 6, 2021

Choose a reason for hiding this comment

jeffpaul Dec 6, 2021

Choose a reason for hiding this comment

jeffpaul Dec 6, 2021

Choose a reason for hiding this comment

jeffpaul commented Dec 6, 2021

jeffpaul left a comment

Choose a reason for hiding this comment

felipeelia commented Dec 6, 2021

jeffpaul Dec 6, 2021

Choose a reason for hiding this comment

jeffpaul Dec 6, 2021

Choose a reason for hiding this comment

jeffpaul left a comment

Choose a reason for hiding this comment

jeffpaul left a comment

Choose a reason for hiding this comment

felipeelia commented Dec 3, 2021 •

edited

Loading