Start using releases

[filipstefansson]

Hey guys,

Should we start using the release/tag system in Github to support older versions of Bootstrap in the future.

If we release 3.0.3.5 now, we can update the repo in the future(Bootstrap 4 or w/e) and still be able to point people who want to use this for Bootstrap 3 to that release.

What to you think?

[filipstefansson]

And maybe even sync our versions with the Bootstrap versiosn to make it super simple for people to find the release that will work with their Bootstrap version...

[MWDelaney]

I've been mostly keeping the version numbers in sync with Bootstrap: when we started supporting the new features of Bootstrap 3.1 I bumped the major version number to 3.1.x, so that makes a ton of sense and doesn't mean a lot of change for us.

I like this plan; we could keep a separate branch for each Bootstrap version we support, too. It means more to keep updated in the case of bugs, but it's a good plan.

[MWDelaney]

One issue will be sub modules. Historically we've had a problem with users downloading from github because the archive doesn't include submodules. Are Releases auto-generated, or can we upload ZIP files?

[MWDelaney]

This might be a subject for a separate issue, but we should make a plan for future major Bootstrap versions and our Wordpress.org repo entry (https://wordpress.org/plugins/bootstrap-3-shortcodes/).

The most logical thing would be to open a separate repo for the Bootstrap 4 version of this plugin (doubly because the number "3" is in the repo name), but I'd like to hear if you guys have any input on that, too.

[filipstefansson]

Github releases doesn't include submodules, and that's a problem... One solution would be to export the README.md file to HTML to be able to remove the Markdown dependency. That would require an export for every update to the README, but maybe it's worth it?

I'm guessing a lot of the back-end code will be the same for Bootstrap 4 so I would suggest either a name change for this repo to something more generic, or just forking it.

[MWDelaney]

Forking it makes sense because, like with the separate releases, there will still be themes using BS3 that will want access to the older version. We wouldn't want the automatic update to suddenly install a plugin they expects BS4.

The export to HTML is a pain. I really wish GitHub supported HTML readmes. Is there any way we could automate it?

[simonyeldon]

Can we not host [a version of] the readme on a GH-Pages?

As for forking - it seems the most sensible. Especially since we have 3 in the title of the repo.

[filipstefansson]

I created a branch that uses HTML instead of Markdown. Have a look at the no_markdown branch and let me know what you think.

I simply used the Mou markdown editor to export README.md to HTML, and I'm sure there's some automated way of doing this if we put some research into it. Like a build script.

[simonyeldon]

Grunt task... https://github.com/treasonx/grunt-markdown

[filipstefansson]

@simonyeldon The no_markdown branch now uses grunt-markdown to generate the README.html file. Thanks for the link.

The workflow with this would be to run grunt every time you update the README.md. Simple enough?

[MWDelaney]

Simon, WordPress doesn't like it when plugins pull in external resources. Grunt works, though.

[MWDelaney]

Woops

[MWDelaney]

Yes, I think this is simple enough. It's a great solution for an obnoxious problem. I'm comfortable using this going forward if everyone else is on board.

[filipstefansson]

There's a pull request for this now, so if @simonyeldon is on board, I'll merge it.

We also agreed that when Bootstrap 4 comes out, we'll create a fork of this repo and continue the development there.

@simonyeldon Feel free to close this issue if you're onboard.

[MWDelaney]

I wonder if the plan to fork the repo for BS4 kinda supercedes the need to use releases :)

[simonyeldon]

Happy to close this now, have put my comments on #83

[MWDelaney]

Sooooo. I went through and back-tagged a bunch of version and wrote up Releases for them.

Because I'm that bored at work today.