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>
Tooltip fade-in/fade-out now works in AMP and everything is functional,
except scroll animation because animated scrolling in AMP has only 3 positions.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2498089 b8457f37-d9ea-0310-8a92-e5e31aec5664
Bugs are now fixed except fade-in/fade-out.
Hopefully we’ll meet the looming deadline.
Thanks for testing and I’ll be reaching out to AMP-WP, in issue #48 to begin with.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2497475 b8457f37-d9ea-0310-8a92-e5e31aec5664
Hopefully we’ll meet the looming deadline.
Thanks for testing and I’ll be reaching out to AMP-WP, in issue #48 to begin with.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2497474 b8457f37-d9ea-0310-8a92-e5e31aec5664
Stable Tag is 2.5.10. v2.6.0d0 does already exist on SVN (2456650 2021-01-14).
Tooltip timing settings are not yet usable in AMP mode.
Tooltip transitions don’t work now, only delays, need to debug.
It’s late and we have a deadline, so this is committed as a preview.
Thanks for looking into it.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2497297 b8457f37-d9ea-0310-8a92-e5e31aec5664
Delta version 2.5.11d4; Stable Tag: 2.5.10.
No changes but sorting by version number.
This makes sure that other changes coming after will be traceable in SVN.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2496283 b8457f37-d9ea-0310-8a92-e5e31aec5664
Delta version 2.5.11d3.
Before sorting constants in settings.php by version number (@since tag).
The next commit is dedicated to moving constants and their docblocks in settings.php.
This replaces most of the list items in the file level docblock.
Moving blocks of code breaks traceability of changes, so it’s usually avoided.
WordPress plugins are supposed to maintain traceability in the SVN repo, which implies keeping changesets meaningful.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2496275 b8457f37-d9ea-0310-8a92-e5e31aec5664
* 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>
branches/staging/ is most up-to-date: 2.5.11d2.
Per WordPress guideline, “trunk/ should contain the latest version of your code, even if that version is a beta.”
See https://developer.wordpress.org/plugins/wordpress-org/how-to-use-subversion/#use-the-trunk-folder-for-code
= Moved files =
Two documentation files are moved from development/ to the root folder:
- customized-template-stack.txt
- customized-documentation-schema.txt
= Deleted files and folders =
Part of the tooling and the duplicate license were mistakenly included and are now removed from distribution:
- development/csscat.sh
- contrib/pre-commit
- composer.json
- composer.lock
- LICENSE
The comments shall be updated accordingly.
development/csscat.sh is now _tools/build-stylesheets.sh, available in Footnotes’ GitHub repo.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2495062 b8457f37-d9ea-0310-8a92-e5e31aec5664
* Adapt after the 2.5.9d1 accident.
* Corrections to changelog.
* Also added @revision and @timestamp PHPDOC tags
@revision and @timestamp used for SVN refs.
Full enumeration of added custom PHPDOC tags:
@accountable, @bib, @biblio, @callback, @commit, @committer, @contributor, @courtesy, @date, @datetime, @lastmodified, @modified, @publisher, @reporter, @revision, @timestamp, @user.Some tags like @reporter and @contributor are more used than others.
* Readme header upgrade.
* Create deploy-to-wordpress.org.yml
* Add distignore
* Comment out `build` command, replace npm with composer
* Remove placeholder comments
* Add build commands
* Fix typo
* Fix version number bug
* Make zip without top-level directory
* Append tag name to plugin zip
* Clean up a bit
* Rename workflow config
* Fix upload paths
* Append tag name to artifact
* Fix paths
* Revert path fix
* Try again
* Add wplm-config.xml to buildfiles
* Fix indentation
* Rename development/csscat.sh to css/csscat.sh
* Rename development/customized-documentation-schema.txt to customized-documentation-schema.txt
* Rename development/customized-template-stack.txt to customized-template-stack.txt
* Version number related fixes before pull request.
* Move csscat script to tools dir
* Rename csscat
* Refactor script
* Update customized-documentation-schema.txt
* Replace empty lines in help output
* Escape empty lines.
* Delete 3 items from `.distignore`
As mentioned, CONTRIBUTING.md and README.md should be included in distributions.
- As an invitation to the Community.
- As a tangible proof of goodwill after the 2.5.9d1 accident.
Also SECURITY.md so Footnotes users see that we’re concerned, and
can reach out without transiting via GitHub.
* Include CONTRIBUTING.md README.md SECURITY.md
* Update sync w/ 5.7 tested.
* Update
* Update composerfiles
Co-authored-by: pewgeuges <73141620+pewgeuges@users.noreply.github.com>
* Update supported WP version to 5.7
* Update package version
* Add Package Version in MAIN.php
* Change version number labels.
* Obfuscate 'Version' string in label.
The way these headers are parsed, best is to make sure that
the string 'Version' doesn’t occur in another field label.
Co-authored-by: pewgeuges <73141620+pewgeuges@users.noreply.github.com>
@revision and @timestamp used for SVN refs.
Full enumeration of added custom PHPDOC tags:
@accountable, @bib, @biblio, @callback, @commit, @committer, @contributor, @courtesy, @date, @datetime, @lastmodified, @modified, @publisher, @reporter, @revision, @timestamp, @user.Some tags like @reporter and @contributor are more used than others.
= Stable Tag value =
2.5.10 (unchanged)
= Commits undone =
- 2484038 (2021-03-02 05:29:18 +0000 (Tue, 02 Mar 2021)) committer: pewgeuges
-2484015 (2021-03-02 04:22:20 +0000 (Tue, 02 Mar 2021)) committer: pewgeuges
= Rationale =
By renaming a folder (and 3 out of 4 included files), the WordPress Coding Standards compliance upgrade (see changeset 2484015) has broken the traceability of the changes made to the following files:
- footnotes/trunk/class/dashboard/init.php
- footnotes/trunk/class/dashboard/layout.php
- footnotes/trunk/class/dashboard/subpage-diagnostics.php
- footnotes/trunk/class/dashboard/subpage-main.php
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2485882 b8457f37-d9ea-0310-8a92-e5e31aec5664
to make footnotes/trunk/ diffable against the standardised codebase on GitHub markcheret/footnotes/.
Stable Tag remains 2.5.10.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2483994 b8457f37-d9ea-0310-8a92-e5e31aec5664
= 2.5.8 =
- Bugfix: Layout: support right-to-left writing direction by replacing remaining CSS values left with start, thanks to @arahmanshaalan bug report.\n- Bugfix: Layout: support right-to-left writing direction by enabling mirrored paddings on HTML dir="rtl" pages, thanks to @arahmanshaalan bug report.
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@2483011 b8457f37-d9ea-0310-8a92-e5e31aec5664
Will be released in response to Forum and as agreed.
= 2.5.8 =
- Bugfix: Layout: support right-to-left writing direction by replacing remaining CSS values 'left' with 'start', thanks to @arahmanshaalan bug report.
- Bugfix: Layout: support right-to-left writing direction by enabling mirrored paddings on HTML dir=rtl pages, thanks to @arahmanshaalan bug report.
