Skip to content

Latest commit

 

History

History
64 lines (49 loc) · 2.7 KB

index.md

File metadata and controls

64 lines (49 loc) · 2.7 KB
Raw
layout
default

Archetypes lets you use git to manage and share project templates

To create a new project using an archetypes template,

bash <(curl http://archetypes.github.io/bootstrap.sh)

The important features for me when I wrote it:

  • Make use of git, and allow for future changes to the template to be merge in to projects that were created from old versions of the template
  • It should be easy to create template files that have content based off of project properties
  • It should be easy to have files in the template whose name (and path) are based off of project properties.
  • It should take as little effort as possible to instantiate a new project

More specifically, the checked-out template is transformed into your project by the following steps:

  • All filenames are url-decoded and evaluated with the liquid template engine (you can reference any of the data in your properties.yaml in your filenames)
  • Any files that end in ".liquid" are processed with the liquid template engine (you can reference any of the data in your properties.yaml)
  • The script itself and its readme are deleted

Making new archetypes

  1. Make a minimal, working project for the platform you want to create an archetype for

  2. Set up your .gitignore and initialize a git repository

    git init
git add .
git commit -m "Working example project"

  3. Merge in the base archetype

    git remote add archetype https://github.com/archetypes/archetype.git
git pull archetype master --allow-unrelated-histories
# resolve merge conflicts
git commit

  4. Parameterize the template. You may want to do one or more of the following

    • Add a .liquid extension to any file and then use
    • Add additional parameters in properties.yaml
    • Use liquid template syntax in any folder name or file name. The name will be URL-decoded before being evaluated by liquid. (For example, {% raw %}{{ package %7C as_path }}{% endraw %})
    • Add additional liquid filters to init.rb
    • Add additional shell commands to the end of init.rb

  5. git commit your parameterized template

  6. Test the template

    # Make sure everything is committed
./init.rb
# Make sure everything works
git reset --hard HEAD^

  7. Fill in "<this repository>" in README.md

  8. Push your archetype to github

  9. If you feel your archetype is stable and of general interest, submit a pull-request to archetypes.github.io/archetypes.txt to have your archetype included in the suggested list