Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
woocommerce/plugins/woocommerce-blocks/CONTRIBUTING.md

8.0 KiB
Raw Blame History

Contributing

Thanks for your interest in contributing to WooCommerce Blocks! Below are some developer docs for working with the project.

To get started you need to install all required dependencies by running the following command in the plugin directory.

npm install && composer install

NPM commands

We have a set of scripts in npm to automate important developer tasks.

Build

  • Run $ npm run build to build all assets for production.
  • Run $ npm start to run the development build and watch for changes.

These scripts compile the code using webpack.

You can also run $ npx webpack to run the development build and not keep watching.

Lint

Run $ npm run lint to check code against our linting rules.

This script runs 3 sub-commands: lint:php, lint:css, lint:js. Use these to run linters across the codebase (linters check for valid syntax).

  • lint:php runs phpcs via composer, which uses the phpcs.xml rule set.
  • lint:css runs stylelint over all the scss code in assets/css, using the rules in .stylelintrc.json.
  • lint:js runs eslint over all the JavaScript, using the rules in .eslintrc.js.

Test

Run $ npm run test to run unit tests on the JavaScript.

The test scripts use wp-scripts to run jest for component and unit testing.

  • test:update updates the snapshot tests for components, used if you change a component that has tests attached.
  • Use test:watch to keep watch of files and automatically re-run tests.

Create a plugin package in ZIP format

Run $ npm run package-plugin to trigger install and build, and then create a zip file which you can use to install WooCommerce Blocks in WordPress admin.

Releasing new versions of blocks

These instructions cover new releases of the blocks plugin for those with commit access.

Prerequisites

  • Have Github Hub cli installed and authenticated.

Before any release ensure you update:

  • The readme.txt file supported versions, changelog and list of blocks if the release includes new blocks.

Note: version numbers will automatically be updated in files via the deploy script (see bin/version-changes.sh).

Creating release branches

When releasing a major or minor feature frozen version of Blocks (e.g. release candidate), create a new release branch from master named release/X.X. This release branch is where you should create tags and releases from.

If post-release fixes or changes are needed, create Pull Requests against master, but label the PR with the correct milestone. For example, if fixing an issue in Blocks 2.5, create a PR against master with a 2.5.x milestone. Once approved and merged to master the same changes will be cherry picked to the release branch.

To do this:

  • Switch to the release branch
  • Run the command (using HUB command line helper): hub am -3 http://URL-TO-PR
  • The command will tell you if the merge was successful. If not, you can cherry pick individual commits using git cherry pick which is more time consuming.
  • Push the changes to origin.
  • After success, label the PR as status: cherry-picked. This lets everyone know the cherry picking has been completed.

You'll also need to manually update the changelog and version numbers in the release branch before tagging. There is a changelog helper script which can list changelog entries from merged PRs in a milestone:

npm run changelog

Follow the instructions, then add the changelog entries to the readme.txt file before committing to the release branch. Once all of this is done, you are safe to run the deploy scripts explained below.

If you're using the GitHub deploy script you no longer need to worry about version bumps; it's automated. The $ npm run deploy (explained below) will update version strings in package.json, readme.text, src/Package.php, and woocommerce-gutenberg-products-block.php for you, committing the changes to the current branch.

Tagging new releases on GitHub

Tagging a new version on GitHub can be done by running the following script:

$ npm run deploy

This will trigger a build and then run the release script (found in /bin/github-deploy.sh). This tags a new version and creates the GitHub release from your current branch.

Important: Before running the deploy script ensure you have committed all changes to GitHub and that you have the correct branch checked out that you wish to release.

If you want to add additional details or a binary file to the release after deployment, you can edit the release here.

Bumping the version in MASTER after releasing a tag

After you release a new version from a release branch there are some other steps to do to keep master up to date.

  • If you released an update with a changelog, create a commit/PR to master with the new changelog entries.
  • Create a commit to master that updates the version to the next minor with a -dev suffix. For example, if you just released 2.5.0, you'd do an update changing the version to 2.6.0-dev. See an example here.

Pushing new releases to WordPress.org

If you have SVN commit access to the WordPress.org plugin repository you can run the following script to prepare a new version:

$ npm run release

This will ask for a tagged version number, check it out from GitHub, check out the SVN repository, and prepare all files. It will give you a command when it's finished to do the actual commit; you have a chance to test/check the files before pushing to WordPress.org.

Important: Before running the release script ensure you have already pushed a new release to GitHub.

Updating a single file in WordPress.org

Sometimes, we need to update a single file in WordPress.org without wanting to do a full release, for example, updating the readme.txt versions or descriptions. In order to do that, refer to the Editing Existing Files section of the Subversion guide in developer.wordpress.org or follow these steps:

  1. Checkout the plugin repo:
svn co "http://plugins.svn.wordpress.org/woo-gutenberg-products-block/"
cd woo-gutenberg-products-block

  1. Modify the files you want to change in trunk or tags/x.y.z.

  2. Check your changes with:

svn stat
svn diff
  1. Commit the changes to the server:
svn ci -m "Updated readme.txt description"

Publishing @woocommerce/block-library

In the past, we published the blocks to NPM at @woocommerce/block-library.

Note: since version 2.3.0 @woocommerce/block-library has been deprecated, you shouldn't publish a new version without first discussing it with the team

To release a new version, perform the following steps:

  • Run npm pack to prep a .tgz file.
  • Optionally test the package by uploading this onto a test site.
  • Run npm publish --access public, which will push the version up to npm.

Legacy builds

This plugin supports two type of builds:

  • legacy builds (assets have -legacy suffix on their file names)
  • main builds (without the -legacy prefix)

The legacy builds are loaded in a site environment where the WordPress version doesn't meet minimum requirements for a components used in a set build.

You can read more about legacy builds in the this doc.