Skip to content

Commit

Permalink
migrate to copier template (#36)
Browse files Browse the repository at this point in the history
  • Loading branch information
pavelzw authored Jan 29, 2024
1 parent 7321de2 commit c314bf4
Show file tree
Hide file tree
Showing 9 changed files with 28 additions and 47 deletions.
7 changes: 7 additions & 0 deletions .copier-answers.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# This file is managed by Copier; DO NOT EDIT OR REMOVE.
_commit: v0.1.1
_src_path: [email protected]:quantco/copier-template-pre-commit-mirrors
description: Source code spell checker, binary install
entry: typos
tool: typos
url: https://github.com/crate-ci/typos
2 changes: 1 addition & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ updates:
- package-ecosystem: github-actions
directory: /
schedule:
interval: weekly
interval: monthly
reviewers:
- quantco/ci
groups:
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/autoupdate.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
name: Autoupdate

on:
workflow_dispatch:
schedule:
Expand All @@ -16,11 +17,10 @@ jobs:
steps:
- name: Checkout branch
uses: actions/checkout@v4
with:
ref: ${{ github.head_ref }}
- name: Set up Conda env
uses: mamba-org/provision-with-micromamba@3c96c0c27676490c63c18bc81f5c51895ac3e0e6
uses: mamba-org/setup-micromamba@e820223f89c8720d6c740ca154a7adf32fcd278a
with:
environment-file: environment.yml
environment-name: check-env
- name: Find latest version
id: versions
Expand All @@ -31,8 +31,8 @@ jobs:
new_version=$(micromamba list -n check-env "$pkgname" --json | jq -r '.[0].version')
if [[ "$new_version" != "$old_version" ]]; then
sed -i "s/$old_version/$new_version/g" environment.yml
echo "pkgname=$pkgname" >> "$GITHUB_OUTPUT"
echo "new-version=$new_version" >> "$GITHUB_OUTPUT"
echo "pkgname=$pkgname" >> $GITHUB_OUTPUT
echo "new-version=$new_version" >> $GITHUB_OUTPUT
fi
- uses: peter-evans/create-pull-request@153407881ec5c347639a548ade7d8ad1d6740e38
if: steps.versions.outputs.pkgname
Expand Down
5 changes: 3 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: CI
on:
push:
branches:
- master
- main
pull_request:

jobs:
Expand All @@ -16,6 +16,7 @@ jobs:
with:
ref: ${{ github.head_ref }}
- name: Set up Conda env
uses: mamba-org/provision-with-micromamba@3c96c0c27676490c63c18bc81f5c51895ac3e0e6
uses: mamba-org/setup-micromamba@e820223f89c8720d6c740ca154a7adf32fcd278a
with:
environment-file: environment.yml
environment-name: test-env
9 changes: 4 additions & 5 deletions .github/workflows/keep-alive.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
name: Keep
on:
# pull_request:
schedule:
- cron: "0 6 * * SUN" # Once weekly on Sunday @ 0600 UTC
- cron: 0 6 * * SUN

jobs:
keep-alive:
Expand All @@ -12,7 +11,7 @@ jobs:
- uses: actions/checkout@v4
- uses: gautamkrishnar/keepalive-workflow@60b13c92aeda855e493b83aaf482c25da7e0043b
with:
commit_message: "Ah ah ah, stayin' alive"
commit_message: Ah ah ah, stayin' alive
committer_username: ForrestQuant
committer_email: "[email protected]"
time_elapsed: 50 # days
committer_email: [email protected]
time_elapsed: 50 # days
1 change: 0 additions & 1 deletion .github/workflows/tag.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ on:
push:
branches:
- main
- master

jobs:
tag:
Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-hooks.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
- id: typos-conda
name: typos-conda
description: Source code spell checker, binary install
language: conda
entry: typos
language: conda
args: [--force-exclude]
types: [text]
stages: [commit, merge-commit, push, manual]
2 changes: 1 addition & 1 deletion LICENSE.txt → LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright 2019 QuantCo, Inc.
Copyright 2024 QuantCo, Inc.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Expand Down
37 changes: 6 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,18 @@
typos(-conda) mirror
====================
# typos mirror

Mirror of typos for pre-commit with conda as a language.

For pre-commit: see https://github.com/pre-commit/pre-commit
For typos: see https://github.com/crate-ci/typos
For pre-commit: see [here](https://github.com/pre-commit/pre-commit)

### Using typos with pre-commit and conda:
For ansible-lint: see [here](https://github.com/crate-ci/typos)

## Using typos with pre-commit and conda:

Add this to your `.pre-commit-config.yaml`

```yaml
- repo: https://github.com/Quantco/pre-commit-mirrors-typos
- repo: https://github.com/quantco/pre-commit-mirrors-typos
rev: '' # Use the sha / tag you want to point at
hooks:
- id: typos-conda
```
### Some Useful Exceptions
For the exact documentation on how to ignore certain typos, see: https://github.com/crate-ci/typos#false-positives . This config
can be included in the `pyproject.toml` of a repository as shown below.

In our projects, some shorter German works are too similar to English words and are picked up. Here is a list of commonly encountered typos:

```toml
[tool.typos]
[tool.typos.default.extend-words]
als = "als"
alle = "alle"
autor = "autor"
beginn = "beginn"
ende = "ende"
iif = "iif"
ist = "ist"
feld = "field"
sie = "sie"
tage = "tage"
titel = "titel"
```

### Flagging Unrecognized Typos
If you notice that there is a typo in your project that is not being caught by `typos`, simply open an issue in this repository.

0 comments on commit c314bf4

Please sign in to comment.