Title: Release Notes
Author: jordanleven
Published: septembre 26, 2017
Last modified: avril 29, 2019
---
Search plugins
This plugin **hasn’t been tested with the latest 3 major releases of WordPress**.
It may no longer be maintained or supported and may have compatibility issues when
used with more recent versions of WordPress.
# Release Notes
By [jordanleven](https://profiles.wordpress.org/jordanleven/)
[Download](https://downloads.wordpress.org/plugin/release-notes.1.0.zip)
* [Details](https://tah.wordpress.org/plugins/release-notes/#description)
* [Reviews](https://tah.wordpress.org/plugins/release-notes/#reviews)
* [Installation](https://tah.wordpress.org/plugins/release-notes/#installation)
* [Development](https://tah.wordpress.org/plugins/release-notes/#developers)
[Support](https://wordpress.org/support/plugin/release-notes/)
## Description
For developers who are deploying multiple themes, it’s useful to have a full version
history that details new features, improvements, and bug fixes. With Release Notes,
this is simpler than ever.
Using the provided .json template and your own style.css main stylesheet, you can
organize your theme deployments in releases (major, minor, and bug fixes).
**Features**
* Works with single installations and Multisite
* Works with parent themes and child themes
* Parses releases notes into easy-to-read sections that show users what features
are new with each new release
**Feature Requests and Bug Reports**
Please report any feature requests you have or bugs you encounter [under the Support tab](https://wordpress.org/support/plugin/release-notes).
This is a new plugin and I’m hoping to add more user-requested features to make
this useful to developers.
**Grunt Integration**
Are you a Grunt user? Check out [release-notes-to-readme on npmJS](https://www.npmjs.com/package/grunt-release-notes-to-readme).
This package can be used to parse our your release notes into a nice ReadMe.md format
that can be included in your theme.
## Screenshots
* [[
* See the current version of your site in the main Dashboard.
* [[
* The release notes for the most current version will show by default.
* [[
* Click on any release to see notes for that version.
## Installation
Upload the Release Notes plugin to your site, and then simply activate it. You’ll
now see the current theme information on your Dashboard and as a submenu under Dashboard.
## FAQ
1. What format do my release notes need to be in?
Use the provided `release-notes-sample.json` file for inspiration. They should fall
under the format of an associative array, where the key for each release notes is
the full version (x.x.x).
```
{
"1.1.0":{
"release_description" : "Version 1.1 of Release Notes has some new features.",
"release_date" : "2017-09-01 00:00:00",
"release_notes" :[
{
"note_title" : "All da features",
"note_description" : null,
"note_bullets" :[
"Mark it up!"
]
}
]
},
"1.0.0":{
"release_description" : "Version 1.0 of Release Notes is a major release that includes a fun new way to view release notes for themes.",
"release_date" : "2017-08-01 00:00:00",
"release_notes" :[
{
"note_title" : "Initial commit",
"note_description" : "You can optionally include descriptions. Otherwise, omit it or make its value null`",
"note_bullets" :[
"Supports text styles",
"And other stuff"
]
},
{
"note_title" : "More features!",
"note_description" : null,
"note_bullets" :[
"Do what ya want"
]
}
]
}
```
}`
Note that `release_description` and `note_description` are optional fields.
2. Where is the current version of the site being pulled in from?
The current version of your site will be pulled using what’s in `style.css`. Ideally,
the most recent version in the release notes will match what’s the current version
is style.css
3. It’s producing an error that says my notes are invalid
Make sure your file is valid! Use a JSON validator like [JSON Lint](https://jsonlint.com)
to validate your notes.
4. It says it cannot find my release notes
Make sure your file is called `release-notes.json` and is located in the root directory
of your theme.
## Reviews
There are no reviews for this plugin.
## Contributors & Developers
“Release Notes” is open source software. The following people have contributed to
this plugin.
Contributors
* [ jordanleven ](https://profiles.wordpress.org/jordanleven/)
[Translate “Release Notes” into your language.](https://translate.wordpress.org/projects/wp-plugins/release-notes)
### Interested in development?
[Browse the code](https://plugins.trac.wordpress.org/browser/release-notes/), check
out the [SVN repository](https://plugins.svn.wordpress.org/release-notes/), or subscribe
to the [development log](https://plugins.trac.wordpress.org/log/release-notes/)
by [RSS](https://plugins.trac.wordpress.org/log/release-notes/?limit=100&mode=stop_on_copy&format=rss).
## Changelog
#### 0.1
* Initial release
## Meta
* Version **1.0.0**
* Last updated **7 années ago**
* Active installations **10+**
* WordPress version ** 2.7 or higher **
* Tested up to **5.2.24**
* Language
* [English (US)](https://wordpress.org/plugins/release-notes/)
* Tags
* [notes](https://tah.wordpress.org/plugins/tags/notes/)[release](https://tah.wordpress.org/plugins/tags/release/)
[themes](https://tah.wordpress.org/plugins/tags/themes/)[versions](https://tah.wordpress.org/plugins/tags/versions/)
* [Advanced View](https://tah.wordpress.org/plugins/release-notes/advanced/)
## Ratings
No reviews have been submitted yet.
[Add my review](https://wordpress.org/support/plugin/release-notes/reviews/#new-post)
[See all reviews](https://wordpress.org/support/plugin/release-notes/reviews/)
## Contributors
* [ jordanleven ](https://profiles.wordpress.org/jordanleven/)
## Support
Got something to say? Need help?
[View support forum](https://wordpress.org/support/plugin/release-notes/)