Ben Goldsworthy
0a34e96450
This commit adds a release helper script, amongst other workflow improvements. See `README.md` for instructions, and `_tools/release.sh` for the script itself. This script: 1. sanity-checks the various version tags; 2. triggers a Plugin build; 3. flags the new version as pre-release; 4. tags the version in Git; 5. creates a local working copy of the SVN repo; 6. copies the new release to the local `trunk/` (whilst keeping the ‘Stable Tag’ field in `readme.txt` pointing to the previous stable version); 7. copies the commit message from the changelog in `readme.txt`; and 8. (if a flag is set) commits the changes to the remote `trunk/`. Pushing out a new release must still be done manually, once `trunk/` is tested and working. To do so, check out a local copy of `trunk/` and: 1. update the ‘Stable Tag’ field in `trunk/readme.txt` to the new version; 2. update the ‘Version’ field in the comment header of `trunk/footnotes.php` to the new version; 3. remove the ‘p’ from the end of the ‘version’ tag in the `getInfo()` function at the bottom of `js/wsiwyg-editor.js`; 4. copy a new tag for the release from `trunk/` (`svn cp trunk tags/<version number>`); and 5. commit your changes (`svn ci -m "Release version <version number>"`). The WP Plugin Directory will automatically parse the ‘Stable Tag’ field in `trunk/readme.txt`, and inform users that a new version is available. At various stages user input is required to validate information. This is not ready for automation with GitHub Actions, but is a useful step on the way — see [this piece](https://blog.danslimmon.com/2019/07/15/do-nothing-scripting-the-key-to-gradual-automation/) for more info. Unless a `-c` flag is passed (e.g., by running `composer run release:commit`) no changes will take place on the remote SVN repo. If you want to test this out on a branch other than `main`, uncomment lines 31 & 52 of the script. Version checking enforces the versioning rules stated [here](https://github.com/markcheret/footnotes/wiki/Versioning). **NB: I have not tested the `-c` mode yet, as I wanted people will more familiarity with the SVN to have a look at it before I risked making any changes and blowing everything up.** Co-authored-by: pewgeuges <73141620+pewgeuges@users.noreply.github.com>
80 lines
2.6 KiB
JavaScript
80 lines
2.6 KiB
JavaScript
/**
|
|
* Created by Stefan on 24.05.14.
|
|
*
|
|
*
|
|
* Edit: be careful to maintain version number near EOF 2020-12-11T1225+0100
|
|
*/
|
|
|
|
(function() {
|
|
tinymce.create('tinymce.plugins.Footnotes', {
|
|
/**
|
|
* Initializes the plugin, this will be executed after the plugin has been created.
|
|
* This call is done before the editor instance has finished its initialization so use the onInit event
|
|
* of the editor instance to intercept that event.
|
|
*
|
|
* @param {tinymce.Editor} ed Editor instance that the plugin is initialized in.
|
|
* @param {string} url Absolute URL to where the plugin is located.
|
|
*/
|
|
init : function(ed, url) {
|
|
ed.addButton('footnotes', {
|
|
title : 'footnotes',
|
|
cmd : 'footnotes',
|
|
image : url + '/../img/fn-wysiwyg.png'
|
|
});
|
|
|
|
ed.addCommand('footnotes', function() {
|
|
jQuery.ajax({
|
|
type: 'POST',
|
|
url: './admin-ajax.php',
|
|
data: {
|
|
action: 'footnotes_getTags'
|
|
},
|
|
success: function(data, textStatus, XMLHttpRequest){
|
|
var l_arr_Tags = JSON.parse(data);
|
|
var return_text = l_arr_Tags['start'] + ed.selection.getContent() + l_arr_Tags['end'];
|
|
ed.execCommand('insertHTML', true, return_text);
|
|
},
|
|
error: function(MLHttpRequest, textStatus, errorThrown){
|
|
console.log("Error: " + errorThrown);
|
|
}
|
|
});
|
|
});
|
|
},
|
|
|
|
/**
|
|
* Creates control instances based in the incomming name. This method is normally not
|
|
* needed since the addButton method of the tinymce.Editor class is a more easy way of adding buttons
|
|
* but you sometimes need to create more complex controls like listboxes, split buttons etc then this
|
|
* method can be used to create those.
|
|
*
|
|
* @param {String} n Name of the control to create.
|
|
* @param {tinymce.ControlManager} cm Control manager to use inorder to create new control.
|
|
* @return {tinymce.ui.Control} New control instance or null if no control was created.
|
|
*/
|
|
createControl : function(n, cm) {
|
|
return null;
|
|
},
|
|
|
|
/**
|
|
* Returns information about the plugin as a name/value array.
|
|
* The current keys are longname, author, authorurl, infourl and version.
|
|
*
|
|
* @return {Object} Name/value array containing information about the plugin.
|
|
*
|
|
* Edit: needs update the version number manually 2020-12-11T1224+0100
|
|
*/
|
|
getInfo : function() {
|
|
return {
|
|
longname : 'Inserts the Footnotes short code.',
|
|
author : 'Mark Cheret',
|
|
authorurl : 'https://cheret.org/footnotes/',
|
|
infourl : 'https://wordpress.org/plugins/footnotes/',
|
|
version : "2.5.11d"
|
|
};
|
|
}
|
|
});
|
|
|
|
// Register plugin
|
|
tinymce.PluginManager.add('footnotes', tinymce.plugins.Footnotes);
|
|
})();
|