Commit graph

30 commits

Author SHA1 Message Date
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
e8d6dbe13d
Automatically generate new releases (#59)
* 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>
2021-03-12 17:53:49 +00:00
pewgeuges
8a01584196 Restore lost corrections 2021-02-28 00:53:50 +01:00
74ac6f1cad Rebase to 2.5.7 2021-02-27 08:34:58 +00:00
9c88d218a8 Revert "Update code to comply with WP Coding Standards (#38)"
This reverts commit 02c6c1c362.
2021-02-27 08:09:08 +00:00
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
04d1bb390b Alter formatting, add contribution information 2021-02-27 07:55:43 +00:00
Mark Cheret
5c1884f059 Update README.md 2021-02-27 07:55:26 +00:00
Mark Cheret
6297965716 Update README.md
moved image due to repo change
2021-02-27 07:54:34 +00:00
Mark Cheret
0f22292941 Update README.md 2021-02-27 07:54:34 +00:00
947a64844a Add more PHPCS tips 2021-02-27 07:54:34 +00:00
f465732b32 Add linting instructions and header image 2021-02-27 07:54:34 +00:00
5ce214cf10 Add getting started instructions to README 2021-02-27 07:54:34 +00:00
b1c6f2fe62 Create README.md 2021-02-27 07:54:34 +00:00
494a116a62 Clarify double-wildcard instructions 2021-02-23 17:58:26 +00:00
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
40d5702d27
Merge pull request #28 from markcheret/footnotes-emphasis
Emphasise plugin name, add contributing guidelines
2021-02-21 13:56:27 +00:00
b11f3bdc2e Alter formatting, add contribution information 2021-02-21 13:53:51 +00:00
ed627acb86
Merge pull request #27 from markcheret/markcheret-patch-2
Update README.md
2021-02-21 13:07:16 +00:00
Mark Cheret
b00d47b757
Update README.md 2021-02-21 13:58:08 +01:00
Mark Cheret
c0b0b8ff7f
Update README.md 2021-02-21 13:42:58 +01:00
Mark Cheret
0d6f5934aa
Update README.md
moved image due to repo change
2021-02-21 13:41:13 +01:00
a1aebed7f4 Add more PHPCS tips 2021-02-21 11:20:11 +00:00
9c9c9721f7 Add linting instructions and header image 2021-02-21 11:08:04 +00:00
22282f9df1 Add getting started instructions to README 2021-02-20 20:55:46 +00:00
8207c90e5e
Create README.md 2021-02-20 19:18:41 +00:00
Mark Cheret
9c615166dc Last preparations for Release 1.0.6
git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@918179 b8457f37-d9ea-0310-8a92-e5e31aec5664
2014-05-20 20:22:30 +00:00
Aricura
cf6f817dfe Version 1.0.5
The Plugin has been submitted to wordpress.org for review and (hopefully) publication.
 * Update: Plugin description for public directories (WordPress.org and GitHub)
 * Feature: the **footnotes** WordPress Plugin now has its very own CI
   * Update: Styling
   * Update: Settings to support the styling
 * Add: Inspirational Screenshots for further development
 * Add: Settings screenshot
 * Update: i18n fine-tuning

git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@917823 b8457f37-d9ea-0310-8a92-e5e31aec5664
2014-05-20 11:53:13 +00:00
Aricura
5d475abfc3 Version 1.0.3
* New setting to use personal starting and ending tag for the footnotes
* Updated translations for the new setting
* Updated reading settings and fallback to default values (bugfix)

git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@917813 b8457f37-d9ea-0310-8a92-e5e31aec5664
2014-05-20 11:42:07 +00:00
Mark Cheret
3321070f7e footnotes WordPress Plugin first alpha release
- Basic functionality is available
- Tested against WordPress 3.9.1

git-svn-id: https://plugins.svn.wordpress.org/footnotes/trunk@917799 b8457f37-d9ea-0310-8a92-e5e31aec5664
2014-05-20 11:23:45 +00:00