https://github.com/blakewilson/wp-enforce-semver

Enforce SemVer in your WordPress plugins with this simple class.
https://github.com/blakewilson/wp-enforce-semver

composer php semantic-versioning semver wordpress wordpress-plugin

Last synced: about 2 months ago
JSON representation

Enforce SemVer in your WordPress plugins with this simple class.

• Host: GitHub
• URL: https://github.com/blakewilson/wp-enforce-semver
• Owner: blakewilson
• Created: 2023-06-22T04:46:39.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-07T04:49:15.000Z (6 months ago)
• Last Synced: 2024-10-19T08:14:13.415Z (2 months ago)
• Topics: composer, php, semantic-versioning, semver, wordpress, wordpress-plugin
• Language: TypeScript
• Homepage: https://packagist.org/packages/blakewilson/wp-enforce-semver
• Size: 216 KB
• Stars: 11
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Enforce SemVer in Your WordPress Plugin

![Screenshot of plugins list with Semantic Versioning for WordPress enabled](https://github.com/blakewilson/wp-enforce-semver/blob/main/.assets/screenshot-1.png?raw=true)

Easily enforce [SemVer](https://semver.org) in your WordPress plugins.

By using this class, auto updates will be disabled when the plugin's new version is a `major` update, and provide a helpful notice in the update section of the plugin that there may be breaking changes.

## Usage

1. Install the class as a dependency via composer:

```

composer require blakewilson/wp-enforce-semver

```

2. Initialize the class in your plugin:

```php

// Init autoloader from Composer

if ( file_exists( plugin_dir_path( __FILE__ ) . 'vendor/autoload.php' ) ) {

	require plugin_dir_path( __FILE__ ) . 'vendor/autoload.php';

}

use EnforceSemVer\EnforceSemVer;

new EnforceSemVer('my-plugin/my-plugin.php');

```

And that's it! Once your end-users install your plugin, they will be protected against auto updates for major releases, and see a helpful message in the plugins list next to your plugin update:

![Screenshot of plugins list with Semantic Versioning for WordPress enabled](https://github.com/blakewilson/wp-enforce-semver/blob/main/.assets/screenshot-1.png?raw=true)

Additionally, this notice text can be modified via a filter:

```php

add_filter( 'semantic_versioning_notice_text', function($notice_text, $plugin_file_name) {

	// Modify notice text here.

	return $notice_text;

});

```