https://github.com/scipp/copier_template

Copier template for Scipp projects
https://github.com/scipp/copier_template

Last synced: about 2 months ago
JSON representation

Copier template for Scipp projects

• Host: GitHub
• URL: https://github.com/scipp/copier_template
• Owner: scipp
• License: bsd-3-clause
• Created: 2023-06-07T12:24:44.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-11-26T13:14:20.000Z (3 months ago)
• Last Synced: 2025-11-29T11:19:27.098Z (3 months ago)
• Language: Jinja
• Size: 536 KB
• Stars: 2
• Watchers: 5
• Forks: 1
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)

# Copier template for Scipp projects

See [copier](https://copier.readthedocs.io/en/stable/) for details.

Usage example:

```sh

copier copy gh:scipp/copier_template myproject  # requires python>=3.9

cd myproject

git init .

tox -e deps  # After adding dependencies to pyproject.toml

git add * .copier-answers.yml .github .gitignore .pre-commit-config.yaml .python-version

git commit -m "Setup from copier_template"

tox -e docs

pip install -e .

git remote add origin git@github.com:scipp/myproject.git

```

## Manual Configuration

Once the project is built from the template, there are manual settings to be configured per project/repository.

### Documentation Deployment

1. Select branch of deployed documentation.

   The documentation will be deployed from a branch via GitHub action.

   The branch of the documentation must be selected manually on GitHub.

   Go to `Settings > Pages` and set `source` as  `Deploy from a branch` and `Branch` as `gh-pages`.

2. Enable website link on repository page.

   Once the branch for the documentation is selected after step `1`, it can be shown in the repository page.

   Go to `repository page` > `About section` (in the right sidebar).

   Click the gear and check the "Use your GitHub Pages website" checkbox for "Website".

### Package Deployment

See [releasing scipp](https://scipp.github.io/reference/developer/releasing-scipp.html#updating-an-expired-anaconda-token) for more information about deployment.

#### Conda

Go to Settings > Secrets > Actions > Organization secrets.

There is `scipp` organization-wide anaconda key, `ANACONDATOKEN`. But it should be enabled per repository.

#### PyPI

1. Create a new project by [adding a trusted publisher](https://docs.pypi.org/trusted-publishers/creating-a-project-through-oidc/).

2. In the GitHub project settings, go to `Environments` and add a new environment `release`.

   Configure appropriate protection rules such as required reviewers and deploying only from protected branches.

### Branch Protection Rules

Go to `Settings > Branches` and in the `Branch protection rules` add rule for `main` branch to project it.

Under `Protect matching branches` setting, select

- [ ] `Require a pull request before merging`

- [ ] `Require approvals`

- [ ] `Require branches to be up to date before merging`

- [ ] `Require status checks to pass before merging`

      You can either use all checks, or select `required` checks only.

      The list of jobs you can select as `required` checks will be shown only after they are triggered at least once within a week.