Skip to content

Commit

Permalink
Merge pull request #32 from xonsh/fix-tests
Browse files Browse the repository at this point in the history
test(fix): failing tests in CI
  • Loading branch information
jnoortheen authored Mar 27, 2023
2 parents fe0b929 + 1b23a30 commit 95692fc
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 11 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -131,3 +131,4 @@ dmypy.json

# pdm
pdm.lock
.pdm.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ repos:
hooks:
- id: trailing-whitespace
- id: check-merge-conflict
- id: check-yaml
# - id: check-yaml
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
A template for creating the <a href="https://github.com/xonsh/xonsh">xonsh</a> contributions called <a href="https://xon.sh/xontribs.html">xontribs</a>.
</p>

<p align="center">
<p align="center">
If you like the template click ⭐ on the repo.
</p>

[![asciicast](https://asciinema.org/a/499605.svg)](https://asciinema.org/a/499605)

## Why use this template?

This template includes good pack of prebuilt files:
This template includes good pack of prebuilt files:

* `README` with the info and xontrib promotion instructions
* [`PEP 621`](https://peps.python.org/pep-0621/) or `poetry` based `pyproject.toml` file to make and install PyPi package easily
* [`PEP 621`](https://peps.python.org/pep-0621/) or `poetry` based `pyproject.toml` file to make and install PyPi package easily
* `.gitattributes` file to enable Github syntax highlighting for `*.xsh` files
* `.gitignore` file with standard list of directories to ignore
* `.github/workflow/push-test.yml` to automatically test the code using Github Actions
Expand Down Expand Up @@ -41,7 +41,7 @@ Create your new xontrib:
copier gh:xonsh/xontrib-template .
```

## Advent of [PEP-621](https://peps.python.org/pep-0621/)
## Advent of [PEP-621](https://peps.python.org/pep-0621/)

Older projects can use the following tools to upgrade their setup to use pyproject.toml

Expand Down
6 changes: 3 additions & 3 deletions project-template/{{ project_repo_name }}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{{project_short_description}}
</p>

<p align="center">
<p align="center">
If you like the idea click ⭐ on the repo and <a href="https://twitter.com/intent/tweet?text=Nice%20xontrib%20for%20the%20xonsh%20shell!&url=https://github.com/{{github_username}}/{{project_repo_name}}" target="_blank">tweet</a>.
</p>

Expand Down Expand Up @@ -43,7 +43,7 @@ xontrib load {{project_package_name}}
{% if enable_pre_commit_hooks %}
- activate [pre-commit](https://github.com/pre-commit/pre-commit) hooks
```sh
# install pre-commit plugins and activate the commit hook
# install pre-commit plugins and activate the commit hook
pre-commit install
pre-commit autoupdate
```
Expand Down Expand Up @@ -74,7 +74,7 @@ After you create the xontrib repository you can do some helpful tasks to spread

**Add xontrib to the awesome-list**. To make your xontrib more discoverable, please add it to the [awesome-xontribs](https://github.com/xonsh/awesome-xontribs).

**Spread the word about your xontrib**. Write a message in [xonsh Gitter chat](https://gitter.im/xonsh/xonsh?utm_source=xontrib-template&utm_medium=xontrib-template-promo&utm_campaign=xontrib-template-promo&utm_content=xontrib-template-promo) and [write a tweet](https://twitter.com/intent/tweet?text=xonsh%20is%20a%20Python-powered,%20cross-platform,%20Unix-gazing%20shell%20language%20and%20command%20prompt.&url=https://github.com/{{github_username}}/{{project_repo_name}}).
**Spread the word about your xontrib**. Write a message in [xonsh Gitter chat](https://gitter.im/xonsh/xonsh?utm_source=xontrib-template&utm_medium=xontrib-template-promo&utm_campaign=xontrib-template-promo&utm_content=xontrib-template-promo) and [write a tweet](https://twitter.com/intent/tweet?text=xonsh%20is%20a%20Python-powered,%20cross-platform,%20Unix-gazing%20shell%20language%20and%20command%20prompt.&url=https://github.com/{{github_username}}/{{project_repo_name}}).

**Easiest way to publish your xontrib to PyPi via Github Actions**. Users can install your xontrib via `pip install xontrib-myxontrib`. Easiest way to achieve it is to use Github Actions:

Expand Down
10 changes: 7 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ build-backend = "setuptools.build_meta"
[project]
# PEP 621 project metadata
# See https://www.python.org/dev/peps/pep-0621/
name = "xontrib-cookiecutter"
name = "xontrib-template"
version = "0.2.0"
description = "Cookiecutter template for Xontrib"
description = "Full-featured template for building extension (xontrib) for the xonsh shell."
authors = [
{ name = "Your Name", email = "[email protected]" },
]
license = { text = "MIT" }
requires-python = ">=3.8,<4.0"
dependencies = [
"copier==6.*",
"copier>=7",
"cookiecutter<2.0.0,>=1.7.3",
"jinja2-time",
]
Expand All @@ -36,3 +36,7 @@ testpaths = [
]
[tool.pdm]
[tool.pdm.dev-dependencies]

[tool.semantic_release]
version_toml = "pyproject.toml:project.version"
version_source = "tag"
1 change: 1 addition & 0 deletions tests/data.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
'.github/pull_request_template.md',
'.github/release-drafter.yml',
'.github/workflows/release.yml',
'.github/workflows/release-drafter.yml',
'.github/workflows/test.yml',
'.gitignore',
'.pre-commit-config.yaml',
Expand Down

0 comments on commit 95692fc

Please sign in to comment.