Announcing continuous integration for tiddlywiki.com

[Jeremy Ruston]

Up until now, making updates to tiddlywiki.com has been a tedious process: the grimy technical details are that I merge a pull request on github.com, and then back on my laptop, I have to pull the changed repository down from GitHub, and then run a script to build the site, and another to upload it to GitHub.

Being so time consuming and inconvenient has meant that we’ve struggled to make timely updates to tiddlywiki.com. I know that this has been a source of discouragement to contributors, and so I’m very happy to have finally been able to address it.

I’ve now enabled “continuous integration” for the TiddlyWiki 5 repo. This means that the site is automatically rebuilt every time a PR is merged or a commit is pushed, without any further manual intervention. It means that I can accept documentation updates and publish them from my phone/tablet sitting on a train.

The main implication for contributors is that documentation PRs should now target the “tiddlywiki-com” branch instead of “master”. (I can change existing PRs as I merge them). I’ll update the docs shortly to make this clear.

The technical details of the changes are discussed on this GitHub issue: https://github.com/Jermolene/TiddlyWiki5/issues/3115

Comments, questions etc. welcome,

Best wishes

Jeremy

[Matthew Lauber]

Hey Jeremy,

A couple questions for you:

1. Does this mean that every merged PR will quickly show up on the prerelease?
2. Should this cause any changes to the contribution process as outside contributors?

Matt Lauber

[Jeremy Ruston]

Hi Matt

A couple questions for you:

1. Does this mean that every merged PR will quickly show up on the prerelease?

Yes, merging a PR triggers a build immediately (it currently takes a good 10 minutes for Travis and GitHub to each do their part).

2. Should this cause any changes to the contribution process as outside contributors?

Just the point noted below that documentation PRs should target the new “tiddlywiki-com” branch.

Best wishes

Jeremy

Matt Lauber

On Tuesday, January 8, 2019 at 10:41:59 AM UTC-5, Jeremy Ruston wrote:

Up until now, making updates to tiddlywiki.com has been a tedious process: the grimy technical details are that I merge a pull request on github.com, and then back on my laptop, I have to pull the changed repository down from GitHub, and then run a script to build the site, and another to upload it to GitHub.

Being so time consuming and inconvenient has meant that we’ve struggled to make timely updates to tiddlywiki.com. I know that this has been a source of discouragement to contributors, and so I’m very happy to have finally been able to address it.

I’ve now enabled “continuous integration” for the TiddlyWiki 5 repo. This means that the site is automatically rebuilt every time a PR is merged or a commit is pushed, without any further manual intervention. It means that I can accept documentation updates and publish them from my phone/tablet sitting on a train.

The main implication for contributors is that documentation PRs should now target the “tiddlywiki-com” branch instead of “master”. (I can change existing PRs as I merge them). I’ll update the docs shortly to make this clear.

The technical details of the changes are discussed on this GitHub issue: https://github.com/Jermolene/TiddlyWiki5/issues/3115

Comments, questions etc. welcome,

Best wishes

Jeremy

--
You received this message because you are subscribed to the Google Groups "TiddlyWikiDev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to tiddlywikide...@googlegroups.com.
To post to this group, send email to tiddly...@googlegroups.com.
Visit this group at https://groups.google.com/group/tiddlywikidev.
To view this discussion on the web visit https://groups.google.com/d/msgid/tiddlywikidev/b0af132f-7626-4cc4-8e13-c0f7ab1152ea%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Mohammad Rahmani]

Great job Jeremy!

 One question, is there any recommendation for preparing documentation tiddlers?

As I have not been involved before, I wish to know some details or a HowTo for preparing or improving TW documentation.

--Mohammad

[Jeremy Ruston]

Hi Mohammad

Have a look here to start with:

https://tiddlywiki.com/#Improving%20TiddlyWiki%20Documentation

Best wishes

Jeremy

--

Jeremy Ruston

jer...@jermolene.com

https://jermolene.com

--

You received this message because you are subscribed to the Google Groups "TiddlyWikiDev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to tiddlywikide...@googlegroups.com.
To post to this group, send email to tiddly...@googlegroups.com.
Visit this group at https://groups.google.com/group/tiddlywikidev.

To view this discussion on the web visit https://groups.google.com/d/msgid/tiddlywikidev/192591e3-1d23-46ea-80bb-12f7f637064a%40googlegroups.com.

[Mohammad Rahmani]

Thanks Jeremy!

 Good stuff. I hope I can contribute

Cheers

Mohammad

[Joshua Fontany]

That is really cool. B)

I know there are tons of tricks/secrets/explanations in the ggroups & streamlining that process really removes a barrier from getting that info onto tiddlywiki.com. (Still learning the ins and outside of git and github myself...)

Any chance you would share the details of your setup? I will need a public website for a tiddlywiki edition in a little while, but haven't really given thought to what that will be structured like.