Skip to content

Latest commit

 

History

History
38 lines (27 loc) · 2.08 KB

README.md

File metadata and controls

38 lines (27 loc) · 2.08 KB
Raw

Setup

Create a repository from this template

  1. Click the big green button Use this template or click here.
  2. Enter a Repository name and click Create repository from template
  3. Head over to the created repository and complete the setup.

Configure the repository so workflows can be added automatically

  1. In a new browser tab, go to the token settings page of your account.
  2. Click "generate new token".
  3. Assign any name like "workflow token", click the "workflow" check box (which will automatically select everything under "repo" as well), then scroll down and click "Generate token".
  4. Copy the token by clicking the icon with the two overlapping squares.
  5. In the other browser tab with your repository, click Settings -> Secrets -> Actions.
  6. Set the name of the secret to REPO_SETUP_TOKEN and paste the token, then click "Add secret"

Complete setup

  1. In the a new repository, complete the project setup by editing the cookiecutter.json file.
  2. Hit cmd + S and then Enter to perform a commit (the commit message doesn't really matter).
  3. Wait Setup Repository Action to complete.
  4. That's it, easy isn't it?

If you have anything to add, please reply in this Twitter thread.

Automated builds

Builds and releases can be automated using GitHub Actions. Tagging a commit with a version tag will trigger a release.

git commit v1.0.0 -m "Release message here!"
git push --tags

What is this all about?

On June 6, 2019, GitHub introduced Repository Templates giving users an easy way to share boilerplate for their projects. This feature is fantastic, but lacking adoption to my knowledge and opinion for one reason... Read the full blog post to learn how to template new projects using repository templates and GitHub Actions.