Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Installation & updates with GitHub Updater #40

Open
benoitchantre opened this issue Apr 25, 2017 · 2 comments
Open

Installation & updates with GitHub Updater #40

benoitchantre opened this issue Apr 25, 2017 · 2 comments

Comments

@benoitchantre
Copy link
Contributor

GitHub Updater is a great solution to manage plugins that are not in the official plugin repository.

One small addition in the plugin banner should be enough to make it work:
GitHub Plugin URI: https://github.com/billerickson/BE-Events-Calendar

I would also suggest to rename the repository with lowercase letters.

@billerickson
Copy link
Owner

As long as this doesn't force updates for all existing users of the plugin, I'm okay with it.

This plugin was originally designed as a "starter" plugin - to be customized for the specific needs of a site. On about a dozen sites I've used this as a base and then modified it to the client's specific needs.

This is why I did not include an updating mechanism, and why I accepted your breaking changes submitted last week (ex: changing the name of the post type).

It looks like updates will only be processed if (1) the user has the GitHub Updater plugin installed, (2) the plugin has the GitHub Plugin URI header, and (3) the version number is higher in the GH repo than on the user's plugin.

  • Past users of this plugin would not be prompted for updates because they don't have (1).
  • New users would only be prompted for updates if they install the GH Updater plugin.
  • On future projects, if I customize the plugin I can set the version number to 99, preventing updates even if they client then installs the GH Updater plugin (ex: for updating a different plugin).

@benoitchantre
Copy link
Contributor Author

Thanks for having merged my breaking changes last week.

I don't know how do you handle the customization for your projects and their maintenance, but if they have a unique repository (even private), the best thing to do is to update the GitHub Plugin URI. That way, you client (or you) will be able to update your plugin through the admin if you use GitHub Updater.
Otherwise, you can simply remove this line.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants