publishing.md

git4ol Publishing

This document is under heavy development as we're currently working on open-learning tutor and that has impact on what you see here

This document outlines how to publish git4ol lesson activity blocks.

Fetch

Make sure to git fetch refs first:

note

In this example we're going to publish activity blocks from the lesson markdown@0.0.0 from the remote origin

user@shell:~/git4ol$ git fetch origin refs/markdown@0.0.0/*:refs/markdown@0.0.0/*

Assets

Generate git subtrees from refs:

note

In this example we're using the current repository ./ to reuse our current origin.

user@shell:~/git4ol$ for ref in $(git for-each-ref --format="%(refname)" refs/markdown@0.0.1); do git subtree add --message "published $ref" --message "published $ref" --prefix=$ref $ref; done

Instructions

Generate .md file with the commit message from refs:

user@shell:~/git4ol$ for ref in $(git for-each-ref --format="%(refname)" refs/markdown@0.0.0); do git log -1 --format="---%nid: %H%n%ntitle: %s%nnotes:%N%n%b" $ref -- > $ref.md; done

JSON

Using markdown-to-json you can now generate activities.json:

note

You have to npm install yourself, make sure to get a version that supports the --content parameter

user@shell:~/git4ol$ m2j --width 0 --content refs/markdown\@0.0.0/*/*.md > refs/markdown\@0.0.0/activities.json

GitHub pages

If you intend to host your lesson using GitHub pages you should turn off Jekyll by adding a .nojekyll file to the root of your gh-pages branch.

note

If you need Jekyll for this site there may be ways to optionally turn this of per path, but I don't know how. Please PR if you do.

Publish

Now all that is left is to git add and git commit our changes before finally doing a git push - but you can do that on your own.