Skip to content

Commit

Permalink
docs: update README about dependabot
Browse files Browse the repository at this point in the history
  • Loading branch information
Undertone0809 committed Mar 4, 2024
1 parent 8062cb2 commit 30ecb94
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 11 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Your next Python package needs a bleeding-edge project structure.

```bash
pip install cookiecutter
cookiecutter gh:Undertone0809/python-package-template --checkout v1.1.6
cookiecutter gh:Undertone0809/python-package-template --checkout v1.1.7
```

> All you need is the latest version of cookiecutter 😉
Expand Down Expand Up @@ -72,7 +72,7 @@ pip install -U cookiecutter
then go to a directory where you want to create your project and run:

```bash
cookiecutter gh:Undertone0809/python-package-template --checkout v1.1.6
cookiecutter gh:Undertone0809/python-package-template --checkout v1.1.7
```

### Input variables
Expand Down
4 changes: 2 additions & 2 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
```bash
pip install cookiecutter
cookiecutter gh:Undertone0809/python-package-template --checkout v1.1.6
cookiecutter gh:Undertone0809/python-package-template --checkout v1.1.7
```

> 你所需要的只是最新版本的 cookiecutter 😉
Expand Down Expand Up @@ -70,7 +70,7 @@ pip install -U cookiecutter
然后转到你想创建项目的目录并运行:

```bash
cookiecutter gh:Undertone0809/python-package-template --checkout v1.1.6
cookiecutter gh:Undertone0809/python-package-template --checkout v1.1.7
```

### 输入变量
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ build-backend = "poetry.core.masonry.api"

[tool.poetry]
name = "python-package-template"
version = "1.1.6"
version = "1.1.7"
description = "Cookiecutter template for Python cli/packages"
readme = "README.md"
authors = ["Zeeland <[email protected]>"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,13 @@ git push -u origin main
- Set up [Dependabot](https://docs.github.com/en/github/administering-a-repository/enabling-and-disabling-version-updates#enabling-github-dependabot-version-updates) to ensure you have the latest dependencies.
- Set up [Stale bot](https://github.com/apps/stale) for automatic issue closing.

> ❗ Dependabot requires `pull_requests:write`, but by default GITHUB_TOKEN has this value set to read-only. You need to do the following to enable it:
> - Go to the repository settings
> - Open the "Actions" tab
> - Click on "Read and write permissions" and enable "Actions: Read and write permissions"
> ![img.png](assets/images/img_1.png)

### Poetry

Want to know more about Poetry? Check [its documentation](https://python-poetry.org/docs/).
Expand Down Expand Up @@ -209,7 +216,7 @@ make pre-commit-install
</details>

<details>
<summary>2. Codestyle and type checks</summary>
<summary>Codestyle and type checks</summary>
<p>

Automatic formatting uses `ruff`.
Expand All @@ -233,7 +240,7 @@ make check-codestyle
</details>

<details>
<summary>3. Code security</summary>
<summary>Code security</summary>
<p>

> If this command is not selected during installation, it cannnot be used.
Expand All @@ -252,7 +259,7 @@ make check-safety
</details>

<details>
<summary>4. Tests with coverage badges</summary>
<summary>Tests with coverage badges</summary>
<p>

Run `pytest`
Expand All @@ -265,7 +272,7 @@ make test
</details>

<details>
<summary>5. All linters</summary>
<summary>All linters</summary>
<p>

Of course there is a command to run all linters in one:
Expand All @@ -284,7 +291,7 @@ make check-codestyle && make test && make check-safety
</details>

<details>
<summary>6. Docker</summary>
<summary>Docker</summary>
<p>

```bash
Expand All @@ -309,7 +316,7 @@ More information [about docker](https://github.com/Undertone0809/python-package-
</details>

<details>
<summary>7. Cleanup</summary>
<summary>Cleanup</summary>
<p>
Delete pycache files

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 30ecb94

Please sign in to comment.