https://github.com/pronamic/pronamic-changelog-md-to-wordpress-plugin-readme-txt
Automates syncing of changelog entries from CHANGELOG.md to WordPress plugin readme.txt.
https://github.com/pronamic/pronamic-changelog-md-to-wordpress-plugin-readme-txt
changelog keepachangelog pronamic wordpress wordpress-development wordpress-plugin wordpress-plugin-development
Last synced: 29 days ago
JSON representation
Automates syncing of changelog entries from CHANGELOG.md to WordPress plugin readme.txt.
- Host: GitHub
- URL: https://github.com/pronamic/pronamic-changelog-md-to-wordpress-plugin-readme-txt
- Owner: pronamic
- License: gpl-2.0
- Created: 2024-10-01T12:03:05.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-10-02T09:31:48.000Z (8 months ago)
- Last Synced: 2025-04-18T11:15:11.292Z (about 2 months ago)
- Topics: changelog, keepachangelog, pronamic, wordpress, wordpress-development, wordpress-plugin, wordpress-plugin-development
- Language: PHP
- Homepage:
- Size: 18.6 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pronamic `CHANGELOG.md` to WordPress plugin `readme.txt`
Automates syncing of changelog entries from `CHANGELOG.md` to WordPress plugin `readme.txt`.
## Table of contents
- [Usage](#usage)
- [Exit code](#exit-code)
- [Links](#links)
## Usage
To keep this library simple, two markers are needed in `CHANGELOG.md` and `readme.txt`.
```
```
```
```
### WordPress plugin `readme.txt`
https://wordpress.org/plugins/readme.txt
```
=== Plugin Name ===
Contributors: (this should be a list of wordpress.org userid's)
Donate link: https://example.com/
Tags: tag1, tag2
Requires at least: 4.7
Tested up to: 5.4
Stable tag: 4.3
Requires PHP: 7.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
Here is a short description of the plugin. This should be no more than 150 characters. No markup here.
== Description ==
This is the long description. No limit, and you can use Markdown (as well as in the following sections).
== Changelog ==
⬇️
ℹ️ This is where the content from CHANGELOG.md is inserted.
⬆️
```
If you don't want to include the complete `CHANGELOG.md` in your `readme.txt` you can move the `` marker to the desired position. Additionally you can include a text below the `` marker in the `readme.txt` file, for example:
```
[See changelog for all versions.](https://github.com/…/blob/main/CHANGELOG.md)
```
### Composer script
```json
"scripts": {
"changelog": "Pronamic\\ChangelogMdToWordPressPluginReadmeTxt\\Synchronizer::run"
}
```
```json
"scripts": {
"changelog": "vendor/bin/pronamic-changelog-md-to-wordpress-plugin-readme-txt"
}
```
## Exit code
| Exit code | Description |
| --------- | ----------- |
| `0` | Succes. |
| `1` | Error. |
## Links
- https://keepachangelog.com/
- https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/
- https://everything.curl.dev/cmdline/exitcode.html
- https://github.com/Automattic/wordbless