Skip to content

Commit 8660c8e

Browse files
dannyvankootendannyvankooten
committed
fix readme, add changelog for 3.3.2 and add release script
1 parent 5425471 commit 8660c8e

3 files changed

Lines changed: 215 additions & 133 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
Changelog
22
==========
33

4+
#### 3.3.2 - Oct 02, 2024
5+
6+
- The Boxzilla script itself is now deferred for improved client-side performance.
7+
- You can now use the Boxzilla JS API before the script has fully loaded.
8+
- Minor server side performance improvements by getting rid of unnecessary sprintf calls or string copies.
9+
- All i18n function call return values are now HTML escaped.
10+
- Verify `Jetpack::is_module_active` exists before method is called.
11+
12+
413
#### 3.3.1 - May 17, 2024
514

615
- Minor performance improvements to plugin bootstrapping and autoloader implementation.

‎create-version.sh‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
#!/usr/bin/env bash
2+
3+
set -euo pipefail
4+
5+
# Check if VERSION argument was supplied
6+
if [ "$#" -lt 1 ]; then
7+
echo "1 parameters expected, $# found"
8+
echo "Usage: package.sh <VERSION>"
9+
exit 1
10+
fi
11+
12+
PLUGIN_SLUG=$(basename "$PWD")
13+
PLUGIN_FILE="$PLUGIN_SLUG.php"
14+
VERSION=$1
15+
PACKAGE_FILE="$PWD/../$PLUGIN_SLUG-$VERSION.zip"
16+
17+
# Check if we're inside plugin directory
18+
if [ ! -e "$PLUGIN_FILE" ]; then
19+
echo "Plugin entry file not found. Please run this command from inside the $PLUGIN_SLUG directory."
20+
exit 1
21+
fi
22+
23+
# Check if there are uncommitted changes
24+
if [ -n "$(git status --porcelain)" ]; then
25+
echo "There are uncommitted changes. Please commit those changes before initiating a release."
26+
exit 1
27+
fi
28+
29+
# Check if there is an existing file for this release already
30+
rm -f "$PACKAGE_FILE"
31+
32+
# Build (optimized) client-side assets
33+
npm run build
34+
35+
# Update version numbers in code
36+
sed -i "s/^Version: .*$/Version: $VERSION/g" "$PLUGIN_FILE"
37+
sed -i "s/define('\(.*_VERSION\)', '.*');/define('\1', '$VERSION');/g" "$PLUGIN_FILE"
38+
sed -i "s/^Stable tag: .*$/Stable tag: $VERSION/g" "readme.txt"
39+
40+
# Copy over changelog from CHANGELOG.md to readme.txt
41+
# Ref: https://git.sr.ht/~dvko/dotfiles/tree/master/item/bin/wp-update-changelog
42+
wp-update-changelog
43+
44+
# Move up one directory level because we need plugin directory in ZIP file
45+
cd ..
46+
47+
# Create archive (excl. development files)
48+
zip -r "$PACKAGE_FILE" "$PLUGIN_SLUG" \
49+
-x "$PLUGIN_SLUG/.*" \
50+
-x "$PLUGIN_SLUG/vendor/*" \
51+
-x "$PLUGIN_SLUG/node_modules/*" \
52+
-x "$PLUGIN_SLUG/tests/*" \
53+
-x "$PLUGIN_SLUG/webpack.config*.js" \
54+
-x "$PLUGIN_SLUG/*.json" \
55+
-x "$PLUGIN_SLUG/*.lock" \
56+
-x "$PLUGIN_SLUG/phpcs.xml" \
57+
-x "$PLUGIN_SLUG/phpunit.xml.dist" \
58+
-x "$PLUGIN_SLUG/*.sh" \
59+
-x "$PLUGIN_SLUG/assets/src/*" \
60+
-x "$PLUGIN_SLUG/sample-code-snippets/*"
61+
62+
cd "$PLUGIN_SLUG"
63+
64+
SIZE=$(ls -lh "$PACKAGE_FILE" | cut -d' ' -f5)
65+
echo "$(basename "$PACKAGE_FILE") created ($SIZE)"
66+
67+
# # Create tag in Git and push to remote
68+
git add . -A
69+
git commit -m "v$VERSION"
70+
git tag "$VERSION"
71+
# git push origin main
72+
# git push origin "tags/$VERSION"

‎readme.txt‎

Lines changed: 134 additions & 133 deletions
Original file line numberDiff line numberDiff line change
@@ -1,134 +1,133 @@
1-
=== Boxzilla ===
2-
Contributors: Ibericode, DvanKooten, hchouhan, lapzor
3-
Donate link: https://boxzillaplugin.com/#utm_source=wp-plugin-repo&utm_medium=boxzilla&utm_campaign=donate-link
4-
Tags: pop-up, optin, call to action, exit intent
5-
Requires at least: 4.6
1+
=== Boxzilla ===
2+
Contributors: Ibericode, DvanKooten, hchouhan, lapzor
3+
Donate link: https://boxzillaplugin.com/#utm_source=wp-plugin-repo&utm_medium=boxzilla&utm_campaign=donate-link
4+
Tags: pop-up, optin, call to action, exit intent
5+
Requires at least: 4.6
66
Tested up to: 6.6
77
Stable tag: 3.3.1
8-
License: GPLv2 or later
9-
License URI: http://www.gnu.org/licenses/gpl-2.0.html
10-
Requires PHP: 7.0
11-
12-
Flexible pop-ups or slide-ins, showing up at just the right time.
13-
14-
== Description ==
15-
16-
### Boxzilla for WordPress
17-
18-
Boxzilla is a plugin allowing you to add pop-up or slide-in boxes to your WordPress site. Boxes can slide or fade in at any point and can contain whatever content you like.
19-
20-
#### Some of Boxzilla's features
21-
22-
- Boxes can contain any content you like.
23-
- You can show boxes at various events:
24-
- After scrolling down past a certain percentage of the page height.
25-
- After scrolling down to a specific page element.
26-
- After X seconds on the page.
27-
- After X pageviews on the site.
28-
- Manually by clicking a link or button
29-
- When the user intents to exit your website (Premium)
30-
- After X seconds on the site (any page). (Premium)
31-
- Customizable box position on the screen.
32-
- Animations for showing or hiding boxes.
33-
- Page targeting, to only show pop-ups on certain posts or pages.
34-
- Full control over how long boxes should stay hidden once they are dismissed.
35-
- Customizable box appearance using a simple visual interface.
36-
- Only 6 kB of JavaScript is added to your website.
37-
38-
[Read more about Boxzilla](https://boxzillaplugin.com/#utm_source=wp-plugin-repo&utm_medium=boxzilla&utm_campaign=description).
39-
40-
> #### Premium add-ons for Boxzilla
41-
>
42-
> The Boxzilla plugin itself is entirely free. Advanced functionality is available through several paid add-ons. Not only do they extend the core functionality of the plugin, they also help to fund further development of the core (free) plugin.
43-
>
44-
> [Browse available add-ons for Boxzilla](https://boxzillaplugin.com/add-ons/#utm_source=wp-plugin-repo&utm_medium=boxzilla&utm_campaign=description).
45-
46-
#### Documentation
47-
48-
Please have a look at the [Boxzilla Knowledge Base](https://kb.boxzillaplugin.com/).
49-
50-
#### Demo
51-
52-
There's a [Boxzilla demo site](https://demo.boxzillaplugin.com#utm_source=wp-plugin-repo&utm_medium=boxzilla&utm_campaign=description) with some examples.
53-
54-
#### Support
55-
56-
Please use the [WordPress.org plugin support forums](https://wordpress.org/support/plugin/boxzilla) for community support.
57-
58-
If you're a [Boxzilla Premium customer](https://boxzillaplugin.com/pricing#utm_source=wp-plugin-repo&utm_medium=boxzilla&utm_campaign=description), please use our support email for a faster reply.
59-
60-
== Frequently Asked Questions ==
61-
62-
= What does this plugin do? =
63-
64-
Pop-ups. Have a look at the [Boxzilla demo site](https://demo.boxzillaplugin.com/#utm_source=wp-plugin-repo&utm_medium=boxzilla&utm_campaign=description).
65-
66-
= How to display a form in the box? =
67-
68-
Boxzilla will work with any plugin that allows for shortcodes, like [MailChimp for WordPress](https://wordpress.org/plugins/mailchimp-for-wp/) or [HTML Forms](https://wordpress.org/plugins/html-forms/).
69-
70-
= Can I have a box open after clicking a certain link or button? =
71-
72-
Yes, you can create a link that refers the box ID. For example, if your box has an ID of 94.
73-
74-
`
75-
<a href="#boxzilla-94">Open Box</a>
76-
`
77-
78-
= Can I have a box open right after loading a page? =
79-
80-
You can configure this in the box settings. Or you can add `#boxzilla-13` to your URL, where 13 is the ID of the box you want to show.
81-
82-
= Can I customize the appearance of a box =
83-
84-
Boxzilla comes with a simple interface for customizing the pop-up appearance. But you can also use your own custom CSS if needed.
85-
86-
`
87-
.boxzilla { } /* all boxes */
88-
.boxzilla-5 { } /* only the box with ID 5 */
89-
`
90-
91-
= I want to disable auto-paragraphs in the box content =
92-
93-
All default WordPress filters are added to the `boxzilla_box_content` filter hook. The example below shows how to remove them.
94-
95-
`
96-
remove_filter( 'boxzilla_box_content', 'wptexturize') ;
97-
remove_filter( 'boxzilla_box_content', 'convert_smilies' );
98-
remove_filter( 'boxzilla_box_content', 'convert_chars' );
99-
remove_filter( 'boxzilla_box_content', 'wpautop' );
100-
remove_filter( 'boxzilla_box_content', 'do_shortcode' );
101-
remove_filter( 'boxzilla_box_content', 'shortcode_unautop' );
102-
`
103-
104-
105-
== Installation ==
106-
107-
= Installing the plugin =
108-
109-
1. In your WordPress admin panel, go to *Plugins > New Plugin*, search for *Boxzilla* and click "Install now"
110-
1. Alternatively, download the plugin and upload the contents of `boxzilla.zip` to your plugins directory, which usually is `/wp-content/plugins/`.
111-
1. Activate the plugin.
112-
1. (Optional) Install some [add-on plugins for Boxzilla](https://boxzillaplugin.com/add-ons/)
113-
114-
= Creating a Boxzilla box =
115-
116-
1. Go to *Boxzilla > Add New*
117-
1. Add some content to the box
118-
1. (Optional) customize the appearance of the box by changing the *Appearance Settings*
119-
120-
= Additional Customization =
121-
122-
Have a look at the [frequently asked questions](https://wordpress.org/plugins/boxzilla/faq/) section for some examples of additional customization.
123-
124-
== Screenshots ==
125-
126-
1. A Boxzilla pop-up with a newsletter sign-up form.
127-
3. Another Boxzilla pop-up, with different styles.
128-
4. Screenshot of the page to manage a Boxzilla pop-up.
129-
130-
131-
== Changelog ==
8+
License: GPLv2 or later
9+
License URI: http://www.gnu.org/licenses/gpl-2.0.html
10+
Requires PHP: 7.0
11+
12+
Flexible pop-ups or slide-ins, showing up at just the right time.
13+
14+
== Description ==
15+
16+
### Boxzilla for WordPress
17+
18+
Boxzilla is a plugin allowing you to add pop-up or slide-in boxes to your WordPress site. Boxes can slide or fade in at any point and can contain whatever content you like.
19+
20+
#### Some of Boxzilla's features
21+
22+
- Boxes can contain any content you like.
23+
- You can show boxes at various events:
24+
- After scrolling down past a certain percentage of the page height.
25+
- After scrolling down to a specific page element.
26+
- After X seconds on the page.
27+
- After X pageviews on the site.
28+
- Manually by clicking a link or button
29+
- When the user intents to exit your website (Premium)
30+
- After X seconds on the site (any page). (Premium)
31+
- Customizable box position on the screen.
32+
- Animations for showing or hiding boxes.
33+
- Page targeting, to only show pop-ups on certain posts or pages.
34+
- Full control over how long boxes should stay hidden once they are dismissed.
35+
- Customizable box appearance using a simple visual interface.
36+
- Only 6 kB of JavaScript is added to your website.
37+
38+
[Read more about Boxzilla](https://boxzillaplugin.com/#utm_source=wp-plugin-repo&utm_medium=boxzilla&utm_campaign=description).
39+
40+
> #### Premium add-ons for Boxzilla
41+
>
42+
> The Boxzilla plugin itself is entirely free. Advanced functionality is available through several paid add-ons. Not only do they extend the core functionality of the plugin, they also help to fund further development of the core (free) plugin.
43+
>
44+
> [Browse available add-ons for Boxzilla](https://boxzillaplugin.com/add-ons/#utm_source=wp-plugin-repo&utm_medium=boxzilla&utm_campaign=description).
45+
46+
#### Documentation
47+
48+
Please have a look at the [Boxzilla Knowledge Base](https://kb.boxzillaplugin.com/).
49+
50+
#### Demo
51+
52+
There's a [Boxzilla demo site](https://demo.boxzillaplugin.com#utm_source=wp-plugin-repo&utm_medium=boxzilla&utm_campaign=description) with some examples.
53+
54+
#### Support
55+
56+
Please use the [WordPress.org plugin support forums](https://wordpress.org/support/plugin/boxzilla) for community support.
57+
58+
If you're a [Boxzilla Premium customer](https://boxzillaplugin.com/pricing#utm_source=wp-plugin-repo&utm_medium=boxzilla&utm_campaign=description), please use our support email for a faster reply.
59+
60+
== Frequently Asked Questions ==
61+
62+
= What does this plugin do? =
63+
64+
Pop-ups. Have a look at the [Boxzilla demo site](https://demo.boxzillaplugin.com/#utm_source=wp-plugin-repo&utm_medium=boxzilla&utm_campaign=description).
65+
66+
= How to display a form in the box? =
67+
68+
Boxzilla will work with any plugin that allows for shortcodes, like [MailChimp for WordPress](https://wordpress.org/plugins/mailchimp-for-wp/) or [HTML Forms](https://wordpress.org/plugins/html-forms/).
69+
70+
= Can I have a box open after clicking a certain link or button? =
71+
72+
Yes, you can create a link that refers the box ID. For example, if your box has an ID of 94.
73+
74+
`
75+
<a href="#boxzilla-94">Open Box</a>
76+
`
77+
78+
= Can I have a box open right after loading a page? =
79+
80+
You can configure this in the box settings. Or you can add `#boxzilla-13` to your URL, where 13 is the ID of the box you want to show.
81+
82+
= Can I customize the appearance of a box =
83+
84+
Boxzilla comes with a simple interface for customizing the pop-up appearance. But you can also use your own custom CSS if needed.
85+
86+
`
87+
.boxzilla { } /* all boxes */
88+
.boxzilla-5 { } /* only the box with ID 5 */
89+
`
90+
91+
= I want to disable auto-paragraphs in the box content =
92+
93+
All default WordPress filters are added to the `boxzilla_box_content` filter hook. The example below shows how to remove them.
94+
95+
`
96+
remove_filter( 'boxzilla_box_content', 'wptexturize') ;
97+
remove_filter( 'boxzilla_box_content', 'convert_smilies' );
98+
remove_filter( 'boxzilla_box_content', 'convert_chars' );
99+
remove_filter( 'boxzilla_box_content', 'wpautop' );
100+
remove_filter( 'boxzilla_box_content', 'do_shortcode' );
101+
remove_filter( 'boxzilla_box_content', 'shortcode_unautop' );
102+
`
103+
104+
== Installation ==
105+
106+
= Installing the plugin =
107+
108+
1. In your WordPress admin panel, go to *Plugins > New Plugin*, search for *Boxzilla* and click "Install now"
109+
1. Alternatively, download the plugin and upload the contents of `boxzilla.zip` to your plugins directory, which usually is `/wp-content/plugins/`.
110+
1. Activate the plugin.
111+
1. (Optional) Install [add-on plugins for Boxzilla](https://boxzillaplugin.com/add-ons/)
112+
113+
= Creating a Boxzilla box =
114+
115+
1. Go to *Boxzilla > Add New*
116+
1. Add some content to the box
117+
1. (Optional) customize the appearance of the box by changing the *Appearance Settings*
118+
119+
= Additional Customization =
120+
121+
Have a look at the [frequently asked questions](https://wordpress.org/plugins/boxzilla/faq/) section for some examples of additional customization.
122+
123+
== Screenshots ==
124+
125+
1. A Boxzilla pop-up with a newsletter sign-up form.
126+
3. Another Boxzilla pop-up, with different styles.
127+
4. Screenshot of the page to manage a Boxzilla pop-up.
128+
129+
== Changelog ==
130+
132131

133132

134133
#### 3.3.1 - May 17, 2024
@@ -640,7 +639,9 @@ Initial release of [Boxzilla](https://boxzillaplugin.com/), formerly known as [S
640639

641640
If you're upgrading from the old plugin, please check [updating to Boxzilla from Scroll Triggered Boxes](https://kb.boxzillaplugin.com/updating-from-scroll-triggered-boxes/) for a list of changes you should be aware of.
642641

643-
== Upgrade Notice ==
644-
645-
= 2.1 =
646-
Added autocomplete to box filters & minor bux fixes for filter rules.
642+
643+
== Upgrade Notice ==
644+
645+
= 2.1 =
646+
647+
Added autocomplete to box filters & minor bux fixes for filter rules.

0 commit comments

Comments
 (0)