Skip to content

Commit

Permalink
Small update on docs and bumps (#147)
Browse files Browse the repository at this point in the history
* Bump tweet release version

* Add command for syrupy snapshot update

* Update copier command in README
  • Loading branch information
klaasnicolaas authored Jun 6, 2024
1 parent 983f145 commit 9a3de54
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@ pipx install copier
Decide where you want to create your new project, run the following command and answer all the questions:

```shell
copier copy --trust gh:klaasnicolaas/pypackage-template ./path/to/destination
copier copy --trust gh:klaasnicolaas/pypackage-template ~/path/to/destination
```

Or if you want to use the latest version from the main branch:

```shell
copier copy --trust --vcs-ref=HEAD gh:klaasnicolaas/pypackage-template ./path/to/destination
copier copy --trust --vcs-ref=HEAD gh:klaasnicolaas/pypackage-template ~/path/to/destination
```

## Publishing to PyPI
Expand Down
2 changes: 1 addition & 1 deletion template/.github/workflows/release.yaml.j2
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ jobs:
runs-on: ubuntu-latest
needs: release
steps:
- uses: Eomm/why-don-t-you-tweet@v1
- uses: Eomm/why-don-t-you-tweet@v2
with:
# GitHub event payload
# https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#release
Expand Down
6 changes: 6 additions & 0 deletions template/README.md.j2
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,12 @@ To run just the Python tests:
poetry run pytest
```

To update the [syrupy](https://github.com/tophat/syrupy) snapshot tests:

```bash
poetry run pytest --snapshot-update
```

## License

{% if software_license == 'MIT License' -%}
Expand Down

0 comments on commit 9a3de54

Please sign in to comment.