Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(pre-commit): fix pre-commit YAML style #8146

Merged
merged 6 commits into from
Jul 7, 2023
Merged

docs(pre-commit): fix pre-commit YAML style #8146

merged 6 commits into from
Jul 7, 2023

Conversation

MicaelJarniac
Copy link
Contributor

@MicaelJarniac MicaelJarniac commented Jun 30, 2023 •
edited
Loading

Docs only, changed .pre-commit-config.yaml style to match pre-commit's own examples and files.

Changed pre-commit config examples from

repos:
  - repo: https://github.com/python-poetry/poetry
    hooks:
      - id: poetry-check

to

repos:
-   repo: https://github.com/python-poetry/poetry
    hooks:
    -   id: poetry-check

in order to match pre-commit's own style:
https://pre-commit.com/#2-add-a-pre-commit-configuration
https://github.com/pre-commit/pre-commit/blob/main/.pre-commit-config.yaml

@MicaelJarniac
docs(pre-commit): fix pre-commit YAML style
5f2fe32 
Changed pre-commit config examples from
```yaml
repos:
  - repo: https://github.com/python-poetry/poetry
    hooks:
      - id: poetry-check
```
to
```yaml
repos:
-   repo: https://github.com/python-poetry/poetry
    hooks:
    -   id: poetry-check
```
in order to match pre-commit's own style:
https://pre-commit.com/#2-add-a-pre-commit-configuration
https://github.com/pre-commit/pre-commit/blob/main/.pre-commit-config.yaml
@MicaelJarniac
docs(pre-commit): fix grammar
8fc5412
@dimbleby
Copy link
Contributor

dimbleby commented Jun 30, 2023 •
edited
Loading

I see no reason to go along with pre-commit's oddball yaml style!

@Secrus
Copy link
Member

Secrus commented Jun 30, 2023

I agree with dimbleby on that. Grammar changes seem ok to me.

@MicaelJarniac
Copy link
Contributor Author

MicaelJarniac commented Jun 30, 2023 •
edited
Loading

I see no reason to go along with pre-commit's oddball yaml style!

One possible reason, and what actually happened to me, is that when someone sets up pre-commit, they'll likely copy the example and the style from pre-commit's docs, and when they want to add Poetry's hooks, they'll copy it from Poetry's docs and paste it there, and notice the style doesn't match, so they'll have to manually fix it.

pre-commit's YAML style might be odd, but there's a good chance people's .pre-commit-config.yaml will be following that style, since it's what pre-commit itself uses.

But I'll be opening a separate PR with just the grammar changes.

Edit:

@MicaelJarniac MicaelJarniac mentioned this pull request Jun 30, 2023
Merged
@MicaelJarniac MicaelJarniac changed the title docs(pre-commit): fix grammar and pre-commit YAML style docs(pre-commit): fix pre-commit YAML style Jul 3, 2023
@MicaelJarniac
Copy link
Contributor Author

Modified this PR to be just about the YAML style, and opened a separate one for the grammar changes. Feel free to close this one if the YAML changes are totally undesirable.

@Secrus Secrus merged commit 8437d54 into python-poetry:master Jul 7, 2023
@radoering radoering mentioned this pull request Aug 20, 2023
Merged
mwalbeck pushed a commit to mwalbeck/docker-python-poetry that referenced this pull request Aug 27, 2023
@mwalbeck
Update dependency poetry to v1.6.1 (#846)
e9d0ca5 
This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [poetry](https://python-poetry.org/) ([source](https://github.com/python-poetry/poetry), [changelog](https://python-poetry.org/history/)) | minor | `1.5.1` -> `1.6.1` |

---

### Release Notes

<details>
<summary>python-poetry/poetry (poetry)</summary>

### [`v1.6.1`](https://github.com/python-poetry/poetry/blob/HEAD/CHANGELOG.md#161---2023-08-21)

[Compare Source](python-poetry/poetry@1.6.0...1.6.1)

##### Fixed

-   Update the minimum required version of `requests` ([#&#8203;8336](python-poetry/poetry#8336)).

### [`v1.6.0`](https://github.com/python-poetry/poetry/blob/HEAD/CHANGELOG.md#160---2023-08-20)

[Compare Source](python-poetry/poetry@1.5.1...1.6.0)

##### Added

-   **Add support for repositories that do not provide a supported hash algorithm** ([#&#8203;8118](python-poetry/poetry#8118)).
-   **Add full support for duplicate dependencies with overlapping markers** ([#&#8203;7257](python-poetry/poetry#7257)).
-   **Improve performance of `poetry lock` for certain edge cases** ([#&#8203;8256](python-poetry/poetry#8256)).
-   Improve performance of `poetry install` ([#&#8203;8031](python-poetry/poetry#8031)).
-   `poetry check` validates that specified `readme` files do exist ([#&#8203;7444](python-poetry/poetry#7444)).
-   Add a downgrading note when updating to an older version ([#&#8203;8176](python-poetry/poetry#8176)).
-   Add support for `vox` in the `xonsh` shell ([#&#8203;8203](python-poetry/poetry#8203)).
-   Add support for `pre-commit` hooks for projects where the pyproject.toml file is located in a subfolder ([#&#8203;8204](python-poetry/poetry#8204)).
-   Add support for the `git+http://` scheme ([#&#8203;6619](python-poetry/poetry#6619)).

##### Changed

-   **Drop support for Python 3.7** ([#&#8203;7674](python-poetry/poetry#7674)).
-   Move `poetry lock --check` to `poetry check --lock` and deprecate the former ([#&#8203;8015](python-poetry/poetry#8015)).
-   Change future warning that PyPI will only be disabled automatically if there are no primary sources ([#&#8203;8151](python-poetry/poetry#8151)).

##### Fixed

-   Fix an issue where `build-system.requires` were not respected for projects with build scripts ([#&#8203;7975](python-poetry/poetry#7975)).
-   Fix an issue where the encoding was not handled correctly when calling a subprocess ([#&#8203;8060](python-poetry/poetry#8060)).
-   Fix an issue where `poetry show --top-level` did not show top level dependencies with extras ([#&#8203;8076](python-poetry/poetry#8076)).
-   Fix an issue where `poetry init` handled projects with `src` layout incorrectly ([#&#8203;8218](python-poetry/poetry#8218)).
-   Fix an issue where Poetry wrote `.pth` files with the wrong encoding ([#&#8203;8041](python-poetry/poetry#8041)).
-   Fix an issue where `poetry install` did not respect the source if the same version of a package has been locked from different sources ([#&#8203;8304](python-poetry/poetry#8304)).

##### Docs

-   Document **official Poetry badge** ([#&#8203;8066](python-poetry/poetry#8066)).
-   Update configuration folder path for macOS ([#&#8203;8062](python-poetry/poetry#8062)).
-   Add a warning about pip ignoring lock files ([#&#8203;8117](python-poetry/poetry#8117)).
-   Clarify the use of the `virtualenvs.in-project` setting. ([#&#8203;8126](python-poetry/poetry#8126)).
-   Change `pre-commit` YAML style to be consistent with pre-commit's own examples ([#&#8203;8146](python-poetry/poetry#8146)).
-   Fix command for listing installed plugins ([#&#8203;8200](python-poetry/poetry#8200)).
-   Mention the `nox-poetry` package ([#&#8203;8173](python-poetry/poetry#8173)).
-   Add an example with a PyPI source in the pyproject.toml file ([#&#8203;8171](python-poetry/poetry#8171)).
-   Use `reference` instead of deprecated `callable` in the scripts example ([#&#8203;8211](python-poetry/poetry#8211)).

##### poetry-core ([`1.7.0`](https://github.com/python-poetry/poetry-core/releases/tag/1.7.0))

-   Improve performance of marker handling ([#&#8203;609](python-poetry/poetry-core#609)).
-   Allow `|` as a value separator in markers with the operators `in` and `not in` ([#&#8203;608](python-poetry/poetry-core#608)).
-   Put pretty name (instead of normalized name) in metadata ([#&#8203;620](python-poetry/poetry-core#620)).
-   Update list of supported licenses ([#&#8203;623](python-poetry/poetry-core#623)).
-   Fix an issue where PEP 508 dependency specifications with names starting with a digit could not be parsed ([#&#8203;607](python-poetry/poetry-core#607)).
-   Fix an issue where Poetry considered an unrelated `.gitignore` file resulting in an empty wheel ([#&#8203;611](python-poetry/poetry-core#611)).

##### poetry-plugin-export ([`^1.5.0`](https://github.com/python-poetry/poetry-plugin-export/releases/tag/1.5.0))

-   Fix an issue where markers for dependencies required by an extra were not generated correctly ([#&#8203;209](python-poetry/poetry-plugin-export#209)).

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi40Mi40IiwidXBkYXRlZEluVmVyIjoiMzYuNTIuMiIsInRhcmdldEJyYW5jaCI6Im1hc3RlciJ9-->

Reviewed-on: https://git.walbeck.it/walbeck-it/docker-python-poetry/pulls/846
Co-authored-by: renovate-bot <bot@walbeck.it>
Co-committed-by: renovate-bot <bot@walbeck.it>
@github-actions GitHub Actions
Copy link

github-actions bot commented Mar 3, 2024

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 3, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@Secrus Secrus Secrus approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@MicaelJarniac @dimbleby @Secrus