{"id":75166,"date":"2017-09-26T15:35:22","date_gmt":"2017-09-26T15:35:22","guid":{"rendered":"https:\/\/wordpress.org\/plugins\/release-notes\/"},"modified":"2019-04-29T01:01:07","modified_gmt":"2019-04-29T01:01:07","slug":"release-notes","status":"publish","type":"plugin","link":"https:\/\/tah.wordpress.org\/plugins\/release-notes\/","author":15683020,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_crdt_document":"","version":"1.0.0","stable_tag":"1.0","tested":"5.2.24","requires":"2.7","requires_php":"","requires_plugins":"","header_name":"Release Notes","header_author":"Jordan Leven","header_description":"Release Notes is a lightweight plugin used to generate easy to read release notes from a .json file located the root of your theme.","assets_banners_color":"419bdb","last_updated":"2019-04-29 01:01:07","external_support_url":"","external_repository_url":"","donate_link":"","header_plugin_uri":"","header_author_uri":"http:\/\/github.com\/jordanleven","rating":0,"author_block_rating":0,"active_installs":10,"downloads":50837,"num_ratings":0,"support_threads":0,"support_threads_resolved":0,"author_block_count":0,"sections":["description","installation","faq","changelog"],"tags":[],"upgrade_notice":{"0.1":"<p>Initial release<\/p>"},"ratings":{"1":0,"2":0,"3":0,"4":0,"5":0},"assets_icons":{"icon-128x128.png":{"filename":"icon-128x128.png","revision":"1736474","resolution":"128x128","location":"assets"},"icon-256x256.png":{"filename":"icon-256x256.png","revision":"1736474","resolution":"256x256","location":"assets"}},"assets_banners":{"banner-1544x500.png":{"filename":"banner-1544x500.png","revision":"1736474","resolution":"1544x500","location":"assets"},"banner-772x250.png":{"filename":"banner-772x250.png","revision":"1736489","resolution":"772x250","location":"assets"}},"assets_blueprints":{},"all_blocks":[],"tagged_versions":["0.1","1.0"],"block_files":[],"assets_screenshots":{"screenshot-1.png":{"filename":"screenshot-1.png","revision":"1736474","resolution":"1","location":"assets"},"screenshot-2.png":{"filename":"screenshot-2.png","revision":"1736474","resolution":"2","location":"assets"},"screenshot-3.png":{"filename":"screenshot-3.png","revision":"1736474","resolution":"3","location":"assets"}},"screenshots":{"1":"See the current version of your site in the main Dashboard.","2":"The release notes for the most current version will show by default.","3":"Click on any release to see notes for that version."},"jetpack_post_was_ever_published":false},"plugin_section":[],"plugin_tags":[3843,9260,1249,17004],"plugin_category":[43],"plugin_contributors":[146964],"plugin_business_model":[],"class_list":["post-75166","plugin","type-plugin","status-publish","hentry","plugin_tags-notes","plugin_tags-release","plugin_tags-themes","plugin_tags-versions","plugin_category-customization","plugin_contributors-jordanleven","plugin_committers-jordanleven"],"banners":{"banner":"https:\/\/ps.w.org\/release-notes\/assets\/banner-772x250.png?rev=1736489","banner_2x":"https:\/\/ps.w.org\/release-notes\/assets\/banner-1544x500.png?rev=1736474","banner_rtl":false,"banner_2x_rtl":false},"icons":{"svg":false,"icon":"https:\/\/ps.w.org\/release-notes\/assets\/icon-128x128.png?rev=1736474","icon_2x":"https:\/\/ps.w.org\/release-notes\/assets\/icon-256x256.png?rev=1736474","generated":false},"screenshots":[{"src":"https:\/\/ps.w.org\/release-notes\/assets\/screenshot-1.png?rev=1736474","caption":"See the current version of your site in the main Dashboard."},{"src":"https:\/\/ps.w.org\/release-notes\/assets\/screenshot-2.png?rev=1736474","caption":"The release notes for the most current version will show by default."},{"src":"https:\/\/ps.w.org\/release-notes\/assets\/screenshot-3.png?rev=1736474","caption":"Click on any release to see notes for that version."}],"raw_content":"<!--section=description-->\n<p>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.<\/p>\n\n<p>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).<\/p>\n\n<p><strong>Features<\/strong><\/p>\n\n<ul>\n<li>Works with single installations and Multisite<\/li>\n<li>Works with parent themes and child themes<\/li>\n<li>Parses releases notes into easy-to-read sections that show users what features are new with each new release<\/li>\n<\/ul>\n\n<p><strong>Feature Requests and Bug Reports<\/strong><\/p>\n\n<p>Please report any feature requests you have or bugs you encounter <a href=\"https:\/\/wordpress.org\/support\/plugin\/release-notes\">under the Support tab<\/a>. This is a new plugin and I'm hoping to add more user-requested features to make this useful to developers.<\/p>\n\n<p><strong>Grunt Integration<\/strong><\/p>\n\n<p>Are you a Grunt user? Check out <a href=\"https:\/\/www.npmjs.com\/package\/grunt-release-notes-to-readme\">release-notes-to-readme on npmJS<\/a>. This package can be used to parse our your release notes into a nice ReadMe.md format that can be included in your theme.<\/p>\n\n<!--section=installation-->\n<p>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.<\/p>\n\n<!--section=faq-->\n<dl>\n<dt>1. What format do my release notes need to be in?<\/dt>\n<dd><p>Use the provided <code>release-notes-sample.json<\/code> 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).<\/p>\n\n<pre><code>{\n    \"1.1.0\":{\n        \"release_description\" : \"Version 1.1 of Release Notes has some new features.\",\n        \"release_date\" : \"2017-09-01 00:00:00\",\n        \"release_notes\" :[\n            {\n                \"note_title\"       : \"All da features\",\n                \"note_description\" : null,\n                \"note_bullets\"     :[\n                    \"&lt;mark&gt;Mark it up!&lt;\/mark&gt;\"\n                ]\n            }\n        ]\n    },\n    \"1.0.0\":{\n        \"release_description\" : \"Version 1.0 of Release Notes is a major release that includes a fun new way to view release notes for themes.\",\n        \"release_date\" : \"2017-08-01 00:00:00\",\n        \"release_notes\" :[\n            {\n                \"note_title\"       : \"Initial commit\",\n                \"note_description\" : \"You can optionally include descriptions. Otherwise, omit it or make its value null`\",\n            \"note_bullets\"     :[\n                \"Supports &lt;b&gt;text&lt;\/b&gt; &lt;i&gt;styles&lt;\/i&gt;\",\n                \"And other stuff\"\n            ]\n        },\n\n        {\n            \"note_title\"       : \"More features!\",\n            \"note_description\" : null,\n            \"note_bullets\"     :[\n                \"Do what ya want\"\n            ]\n        }\n    ]\n}\n<\/code><\/pre>\n\n<p>}`<\/p>\n\n<p>Note that <code>release_description<\/code> and <code>note_description<\/code> are optional fields.<\/p><\/dd>\n<dt>2. Where is the current version of the site being pulled in from?<\/dt>\n<dd><p>The current version of your site will be pulled using what's in <code>style.css<\/code>. Ideally, the most recent version in the release notes will match what's the current version is style.css<\/p><\/dd>\n<dt>3. It's producing an error that says my notes are invalid<\/dt>\n<dd><p>Make sure your file is valid! Use a JSON validator like <a href=\"https:\/\/jsonlint.com\">JSON Lint<\/a> to validate your notes.<\/p><\/dd>\n<dt>4. It says it cannot find my release notes<\/dt>\n<dd><p>Make sure your file is called <code>release-notes.json<\/code> and is located in the root directory of your theme.<\/p><\/dd>\n\n<\/dl>\n\n<!--section=changelog-->\n<h4>0.1<\/h4>\n\n<ul>\n<li>Initial release<\/li>\n<\/ul>","raw_excerpt":"Release Notes is a WordPress plugin that help you keep track of features that have been added over time to your themes.","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/tah.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin\/75166","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/tah.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin"}],"about":[{"href":"https:\/\/tah.wordpress.org\/plugins\/wp-json\/wp\/v2\/types\/plugin"}],"replies":[{"embeddable":true,"href":"https:\/\/tah.wordpress.org\/plugins\/wp-json\/wp\/v2\/comments?post=75166"}],"author":[{"embeddable":true,"href":"https:\/\/tah.wordpress.org\/plugins\/wp-json\/wporg\/v1\/users\/jordanleven"}],"wp:attachment":[{"href":"https:\/\/tah.wordpress.org\/plugins\/wp-json\/wp\/v2\/media?parent=75166"}],"wp:term":[{"taxonomy":"plugin_section","embeddable":true,"href":"https:\/\/tah.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_section?post=75166"},{"taxonomy":"plugin_tags","embeddable":true,"href":"https:\/\/tah.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_tags?post=75166"},{"taxonomy":"plugin_category","embeddable":true,"href":"https:\/\/tah.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_category?post=75166"},{"taxonomy":"plugin_contributors","embeddable":true,"href":"https:\/\/tah.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_contributors?post=75166"},{"taxonomy":"plugin_business_model","embeddable":true,"href":"https:\/\/tah.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_business_model?post=75166"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}