Commit graph

176 commits

Author SHA1 Message Date
Ben Goldsworthy 0a34e96450
Add release helper script (#64)
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>
2021-03-17 17:46:21 +00:00
Mark Cheret 0a83796cdc
Update author URIs (#63)
* Update author URIs from `cheret.de` to `cheret.org`.

* Update missed version number in `wysiwyg.js` from 2.1.6 to 2.5.10.

Co-authored-by: pewgeuges <73141620+pewgeuges@users.noreply.github.com>
2021-03-15 07:11:12 +00:00
pewgeuges 46fc9a7c5f Adapt after the 2.5.9d1 accident. 2021-03-05 04:30:50 +01:00
pewgeuges 6b9e602d07
Sync filenames with SVN repo (#57)
Returns to the original file names for the `class/dashboard/` directory (for now at least)
2021-03-04 07:46:19 +00:00
Ben Goldsworthy 25c3f2f12e Replace output escape and input sanitization functions with linter supression messages 2021-02-27 08:49:08 +00:00
Ben Goldsworthy 74ac6f1cad Rebase to 2.5.7 2021-02-27 08:34:58 +00:00
Ben Goldsworthy f5b2e1f30f Rebase to 2.5.7 2021-02-27 08:12:17 +00:00
Ben Goldsworthy 9c88d218a8 Revert "Update code to comply with WP Coding Standards (#38)"
This reverts commit 02c6c1c362.
2021-02-27 08:09:08 +00:00
Ben Goldsworthy dac7ffe3a6 Update code to comply with WP Coding Standards (#38)
Co-authored-by: @pewgeuges <pewgeuges@gmail.com>
2021-02-27 08:06:32 +00:00
Ben Goldsworthy 8d0ebdb859 Append line endings 2021-02-27 08:03:04 +00:00
pewgeuges 92365f1176 This very urgent bugfix release contains just one added line of code, fixing the footnotes duplication bug.
= 2.5.7 =

- Bugfix: Process: fix footnote duplication by emptying the footnotes list every time the search algorithm is run on the content, thanks to @inoruhana bug report.

This release cannot be delayed as it responds to a user request with [bug report on the Forum](https://wordpress.org/support/topic/footnote-duplicated-in-the-widget/).
Fast-tracking emergency releases as per instructions received and previous agreement.

git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2482506 b8457f37-d9ea-0310-8a92-e5e31aec5664
2021-02-27 01:39:18 +00:00
Ben Goldsworthy 600910d9ee Remove custom CSS output escaping 2021-02-26 14:40:23 +00:00
Ben Goldsworthy 5982f12bd5 Revert "Update code to comply with WP Coding Standards (#38)"
This reverts commit 02c6c1c362.
2021-02-26 08:07:03 +00:00
Ben Goldsworthy 02c6c1c362
Update code to comply with WP Coding Standards (#38)
Co-authored-by: @pewgeuges <pewgeuges@gmail.com>
2021-02-25 19:17:00 +00:00
pewgeuges b4df058574
File header class/widgets/reference-container.php
Move date to its tag, …
2021-02-25 17:48:04 +01:00
pewgeuges c8d526ebc1
Remove dates in class/widgets/base.php
Remove @‌lastmodified date.
Remove purely documentation related @‌date tag.
2021-02-25 17:35:16 +01:00
pewgeuges 422a6d1fa2 File level headings in class/layout/.
Move date to @‌date tag below the @‌since tag.
Delete @‌lastmodified tag as pointless, easily out of sync, and screwing things up when collaborating.
Need to mention however that in many projects, the last modified datestamp is applied and maintained.
That said, some published files on the web out there contain edits post-dating their datestamp.
2021-02-25 14:22:07 +01:00
pewgeuges a7c103c922 Remove end comment. 2021-02-25 12:01:24 +01:00
pewgeuges cf1fef09cc
Correct phrase (initialism) 2021-02-25 00:02:44 +01:00
pewgeuges bf80a52c07 Edit file level docblocks. 2021-02-24 23:53:22 +01:00
pewgeuges 2111d850aa
Convert script to snake_case 2021-02-24 23:12:41 +01:00
Ben Goldsworthy 8a0658c604 Remove @lastmodified tag, datetime from @since tag 2021-02-24 21:53:17 +00:00
pewgeuges 0dc5f23123 Fix internal script. 2021-02-24 18:02:16 +01:00
pewgeuges 3540815ba7 Small edits. 2021-02-24 17:11:41 +01:00
pewgeuges c1e5e0b33a Update contribution URL class/init.php
The historic repo where @felipelavinz contributed has recently been moved.
As a consequence the commit’s URL needs to be updated.
But the original URL is maintained below under the commit date.
2021-02-24 16:28:34 +01:00
pewgeuges 3f35699047 Fix function name in docblock 2021-02-24 14:36:48 +01:00
pewgeuges bd00fc348f
Same as previous. class/layout/settings.php 2021-02-24 12:52:32 +01:00
pewgeuges 4f666f1300
Docblocks for tooltips class/layout/settings.php
Headings and version for split-off metaboxes docblocks.
Overwrites the todo items.
Thanks for starting the docblocks required by WP coding standards.
2021-02-24 12:26:31 +01:00
pewgeuges 0dfe2ad4d0
Fix translator comments class/layout/settings.php
Titlecase “Translators:”.
Add semicolons.
2021-02-24 12:11:32 +01:00
pewgeuges 4cd3d5e255
Fix&dispatch docblock h. class/layout/settings.php
Fix 2 function docblock headings by dispatching them from the originally single metabox function docblock.
Also add version tags to the 2 metaboxes split off @since 2.2.0.
* Displays all options for the footnotes start and end tag short codes. (Initially called “Footnotes styling”.)
* Displays all options for the footnotes numbering. (Newly individualized.)
* Displays all options for the scrolling behavior. (Totally new as scroll offset and duration were initially hard-coded in the template.)
(This is part of WP coding standard compliance.)
2021-02-24 11:49:08 +01:00
pewgeuges d64e75eac9
Fix line comments in class/layout/init.php 2021-02-23 23:45:01 +01:00
pewgeuges cb43a1f6be
Restore compiler keyword in class/language.php 2021-02-23 21:14:45 +01:00
pewgeuges 1c2afab4b3
Change variable names conventional class/init.php
Name variables in an intuitive manner according to coding conventions.
2021-02-23 20:56:06 +01:00
pewgeuges 63803e147b
Merge docblock restore attributions class/init.php
Merge deleted docblock attributions in remaining docblock.
2021-02-23 20:13:38 +01:00
Ben Goldsworthy b5dc136ffe Replace escape output functions 2021-02-23 18:13:52 +00:00
Ben Goldsworthy 526b5d096f Minor whitespace, commenting tweaks 2021-02-23 17:59:52 +00:00
Ben Goldsworthy 87f2ed4f5c Disable missing nonce errors/warnings for now 2021-02-23 17:59:12 +00:00
Ben Goldsworthy fa8fb3f207 Remove output escaping functions 2021-02-23 17:45:33 +00:00
Ben Goldsworthy 716b213fb8 Replace incorrect option sanitisation function 2021-02-23 17:44:27 +00:00
Ben Goldsworthy 5411e4b279 Replace wp_remote_get() with PHPCS disable. 2021-02-23 17:17:14 +00:00
Ben Goldsworthy 078781b000 Explictly pass false argument to wp_enqueue_script().
Not doing so will result in a `WordPress.WP.EnqueuedResourceParameters.NotInFooter` warning from PHPCS.
2021-02-23 17:15:58 +00:00
Ben Goldsworthy df6bd2c282 Update layout files 2021-02-23 16:48:53 +00:00
Ben Goldsworthy 8ff0d9ee86 Rename dashboard/ to layout/. 2021-02-23 16:48:21 +00:00
Ben Goldsworthy adb2ccbc32 Add temp file 2021-02-23 16:47:39 +00:00
Ben Goldsworthy 4736f19b36 Rename dashboard files 2021-02-23 16:45:57 +00:00
Ben Goldsworthy 9a8e7c0851 Update codebase to be WP Coding Standard-compliant.
This is a squashed copy of `wp-coding-standard--rebase` to try and fix the line-ending
diff issue we're having.
2021-02-23 16:44:18 +00:00
Ben Goldsworthy 9ee72568ef Append line endings 2021-02-23 16:00:59 +00:00
pewgeuges 65874f089b update 2.5.6d4 in case it is tested in the related forum topic.\nFull changelog:\n= 2.5.6 =\n- Bugfix: Reference container: optional alternative expanding and collapsing without jQuery for use with hard links, thanks to @hopper87it @pkverma99 issue reports.\n- Bugfix: Alternative tooltips: shrink width to short content.\n- Update: Documentation: slightly revise / update the plugin’s welcome page on WordPress.org.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2478015 b8457f37-d9ea-0310-8a92-e5e31aec5664
2021-02-20 03:50:52 +00:00
pewgeuges d0fa3c5f97 development update 2.5.6d3 to prepare the newly promised bugfix release adding a reference container template not using jQuery, plain JS instead.
The following is the changelog as drafted for this release: 
= 2.5.6 =
- Bugfix: Reference container: optional alternative expanding and collapsing without jQuery for use with hard links, thanks to @hopper87it issue report.
- Update: Documentation: slightly revise / update the plugin’s welcome page on WordPress.org.

git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2477926 b8457f37-d9ea-0310-8a92-e5e31aec5664
2021-02-19 20:04:11 +00:00
pewgeuges 67c1f443ad development update 2.5.6d2 to prepare the newly promised bugfix release adding a reference container template not using jQuery, plain JS instead.\nThe following is the changelog as drafted for this release: \n= 2.5.6 =\n- Bugfix: Reference container: optional alternative expanding and collapsing without jQuery for use with hard links, thanks to @hopper87it issue report.\n- Update: Documentation: slightly revise / update the plugin’s welcome page on WordPress.org.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2477898 b8457f37-d9ea-0310-8a92-e5e31aec5664
2021-02-19 19:42:45 +00:00