wikimedia / interconnection-wordpress-theme

WordPress theme created for https://diff.wikimedia.org/
GNU General Public License v2.0
3 stars 0 forks source link

Implement GitHub Action build workflows #1

Closed kadamwhite closed 1 year ago

kadamwhite commented 1 year ago

This theme currently contains prebuilt assets: to use it on a deployed WordPress site, if any CSS has been changed then the npm run compile command must also be run, and the updated compiled CSS assets must be manually committed to the repository.

We generally recommend against committing compiled assets to a source code repository because if two different features end up writing changes to the same bundled file, that can cause an unnecessary merge conflict that slows down development. A theme doesn't work without its static assets, though, so the build process needs to happen somewhere.

In the Shiro theme, we use GitHub Actions to build the theme's assets.

Web applications can then install Shiro using a dev-release VCS composer reference, decoupling

This issue tracks implementing the same process for this Interconnection theme.

Proposed tactics

Probably easiest to work directly in main until things are set up properly, rather than PR'ing every single change. This repository is not yet used in a production environment so changes here will not break anything, and there are not yet any branch protection rules set up to prevent pushes directly to main.

If it's easier to include the PHP and JS linting when migrating the other GH actions over, let's bring them along, but we do expect they will fail at first since I believe this repo uses slightly different coding standards.

Acceptance Criteria

pamprn09 commented 1 year ago

@kadamwhite all those items are done. Do we have a ticket for this one? How can we mark this as done once is reviewed and approved?

kadamwhite commented 1 year ago

Note that this is done on issue 633 in the other repo, and then we can close out this ticket. Thanks!