https://github.com/tpluscode/github-copier-template

https://github.com/tpluscode/github-copier-template

copier-template

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/tpluscode/github-copier-template
• Owner: tpluscode
• License: mit
• Created: 2022-02-26T12:38:30.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-07-12T18:08:12.000Z (over 1 year ago)
• Last Synced: 2024-10-24T10:10:01.742Z (2 months ago)
• Topics: copier-template
• Language: Jinja
• Homepage:
• Size: 80.1 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Copier templates for common GitHub config

## Usage

### Installing

Use the `copy` command to add to an existing repo

```

copier -a .copier-github.yaml copy https://github.com/tpluscode/github-copier-template.git .

```

### Updating

```

copier -a .copier-github.yaml update

```

## Core questions

### `changesets`

When true, it will create a GitHub workflow for [Atlassian Changesets](https://github.com/changesets/changesets)

If the package.json exists, it will automatically add a required dependency. Otherwise make sure to add it yourself, for example as

```

yarn add @changesets/cli

```

### `release_with_changesets`

Extends the changesets workflow to also automatically push NPM packages when release PRs are merged.

**You may have to manually add a `release` script to you package.json if it did not exist when initializing the template**

```json

{

  "scripts": {

    "release": "changeset publish"

  }

}

```

### `auto_tag`

Asked when `release_with_changesets` is `false`, adds a GitHub workflow to automatically create tags when chagesets package.json version changes.