Skip to content

Automattic/jetpack-crm

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1,503 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Jetpack CRM - Core CRM Plugin - WordPress.org Hosted


WP compatibility PHP compatibility (Plugin Smoke Test)

Development

The Makefile wraps the common development tasks. Run make help to list every target.

Prerequisites

  • Docker (running) — the local WordPress environment uses @wordpress/env.
  • Node.js and npm.
  • Composer.

First-time setup

make install        # install Composer (PHP) and npm (JS) dependencies
make install-hooks  # optional: install the git pre-push hook (blocks pushes to trunk)

Run WordPress in Docker

make up       # start WordPress at http://localhost:8888 (admin / password)
make down     # stop the containers (keeps the database)
make destroy  # remove the containers and the database

The plugin is mounted into the container, so edits are picked up live (run make build first if you change compiled assets — see below).

Other useful targets

Target What it does
make logs Tail the WordPress container logs
make cli Open a shell inside the cli container
make wp CMD="plugin list" Run a wp-cli command in the container
make test Run the PHPUnit unit suite
make lint Run PHP CodeSniffer on files changed vs trunk
make build Build dist/zero-bs-crm.zip (tracked source from HEAD, assets compiled fresh)
make clean Remove the dist/ staging directory

Publishing a release

Releases are cut from this repository. The flow is two steps: prepare a release PR locally, then merge it to trigger the automated release.

1. Prepare the release PR

Before running, make sure:

  • Your working tree is clean (the command refuses to run otherwise).
  • You are authenticated with the GitHub CLI (gh auth login).
  • A GitHub milestone named after the version (e.g. 6.9.0) exists, with the merged PRs to include assigned to it. The changelog is assembled from those PRs.
make release VERSION=6.9.0

This bumps the version everywhere it appears (plugin header, JPCRM_VERSION, readme.txt stable tag, package.json), assembles the changelog, and opens a release/zero-bs-crm-6.9.0 PR. You can edit the changelog in the PR description in the browser before merging.

2. Merge the PR

Merging the release PR triggers .github/workflows/create-release.yml, which:

  1. writes the (edited) changelog from the PR body into readme.txt,
  2. builds the plugin (make build),
  3. tags the release and creates the GitHub release (with the built zero-bs-crm.zip attached), and
  4. deploys the built plugin to WordPress.org.

The WordPress.org deploy requires the WORDPRESSORG_SVN_USERNAME and WORDPRESSORG_SVN_PASSWORD repository secrets to be set.

About

Jetpack CRM – Clients, Leads, Invoices, Billing, Email Marketing, & Automation

Resources

Security policy

Stars

12 stars

Watchers

4 watching

Forks

Packages

 
 
 

Contributors