webfactory / piwik-bundle

Symfony Bundle with twig-function for the Matomo (fka Piwik) tracking code
MIT License
39 stars 16 forks source link

Rename "use_cacheable_tracking_script" option #1

Closed mpdude closed 10 years ago

mpdude commented 10 years ago

I'd like to suggest renaming the use_cacheable_tracking_script option to something like tracker_uri or so.

The reason is that there are several things you can do with this script (see https://github.com/piwik/piwik/blob/master/js/README.md). Folks might even have custom variants of it and use it as /js/ or /js/index.php.

IMO tracker_uri also is more intention-revealing. It should default to /js/ though :-).

Too bad we've already tagged 1.0 and this is an API break, but I'd accept that and not go for 2.0 because of this.

bnw commented 10 years ago

Agreed, but why not go for 2.0?

mpdude commented 10 years ago

I wanted to avoid a bump to 2.* so early, but you're right. No matter what, the way it's fixed is an API break and there is no need in hiding that.

As we've tagged 1.* already, SemVer would require us to make it 2.0.

mpdude commented 10 years ago

Just noticed that you tagged the change as 2.0 already, so I just added an UPGRADING file to make people aware of it.