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

MicaelJarniac · 2023-06-30T01:44:29Z

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

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

docs/pre-commit-hooks.md

dimbleby · 2023-06-30T07:54:19Z

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

Secrus · 2023-06-30T08:25:12Z

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

MicaelJarniac · 2023-06-30T13:39:32Z

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:

docs(pre-commit): fix FAQ grammar #8150

This reverts commit 8fc5412.

MicaelJarniac · 2023-07-03T21:26:00Z

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.

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` ([#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** ([#8118](python-poetry/poetry#8118)). - **Add full support for duplicate dependencies with overlapping markers** ([#7257](python-poetry/poetry#7257)). - **Improve performance of `poetry lock` for certain edge cases** ([#8256](python-poetry/poetry#8256)). - Improve performance of `poetry install` ([#8031](python-poetry/poetry#8031)). - `poetry check` validates that specified `readme` files do exist ([#7444](python-poetry/poetry#7444)). - Add a downgrading note when updating to an older version ([#8176](python-poetry/poetry#8176)). - Add support for `vox` in the `xonsh` shell ([#8203](python-poetry/poetry#8203)). - Add support for `pre-commit` hooks for projects where the pyproject.toml file is located in a subfolder ([#8204](python-poetry/poetry#8204)). - Add support for the `git+http://` scheme ([#6619](python-poetry/poetry#6619)). ##### Changed - **Drop support for Python 3.7** ([#7674](python-poetry/poetry#7674)). - Move `poetry lock --check` to `poetry check --lock` and deprecate the former ([#8015](python-poetry/poetry#8015)). - Change future warning that PyPI will only be disabled automatically if there are no primary sources ([#8151](python-poetry/poetry#8151)). ##### Fixed - Fix an issue where `build-system.requires` were not respected for projects with build scripts ([#7975](python-poetry/poetry#7975)). - Fix an issue where the encoding was not handled correctly when calling a subprocess ([#8060](python-poetry/poetry#8060)). - Fix an issue where `poetry show --top-level` did not show top level dependencies with extras ([#8076](python-poetry/poetry#8076)). - Fix an issue where `poetry init` handled projects with `src` layout incorrectly ([#8218](python-poetry/poetry#8218)). - Fix an issue where Poetry wrote `.pth` files with the wrong encoding ([#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 ([#8304](python-poetry/poetry#8304)). ##### Docs - Document **official Poetry badge** ([#8066](python-poetry/poetry#8066)). - Update configuration folder path for macOS ([#8062](python-poetry/poetry#8062)). - Add a warning about pip ignoring lock files ([#8117](python-poetry/poetry#8117)). - Clarify the use of the `virtualenvs.in-project` setting. ([#8126](python-poetry/poetry#8126)). - Change `pre-commit` YAML style to be consistent with pre-commit's own examples ([#8146](python-poetry/poetry#8146)). - Fix command for listing installed plugins ([#8200](python-poetry/poetry#8200)). - Mention the `nox-poetry` package ([#8173](python-poetry/poetry#8173)). - Add an example with a PyPI source in the pyproject.toml file ([#8171](python-poetry/poetry#8171)). - Use `reference` instead of deprecated `callable` in the scripts example ([#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 ([#609](python-poetry/poetry-core#609)). - Allow `|` as a value separator in markers with the operators `in` and `not in` ([#608](python-poetry/poetry-core#608)). - Put pretty name (instead of normalized name) in metadata ([#620](python-poetry/poetry-core#620)). - Update list of supported licenses ([#623](python-poetry/poetry-core#623)). - Fix an issue where PEP 508 dependency specifications with names starting with a digit could not be parsed ([#607](python-poetry/poetry-core#607)). - Fix an issue where Poetry considered an unrelated `.gitignore` file resulting in an empty wheel ([#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 ([#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. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  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 · 2024-03-03T20:50:28Z

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.

MicaelJarniac added 2 commits June 29, 2023 22:40

docs(pre-commit): fix grammar

8fc5412

MicaelJarniac commented Jun 30, 2023

View reviewed changes

docs/pre-commit-hooks.md Outdated Show resolved Hide resolved

docs(pre-commit): fix grammar fix

6bc69c9

MicaelJarniac mentioned this pull request Jun 30, 2023

docs(pre-commit): fix FAQ grammar #8150

Merged

Revert "docs(pre-commit): fix grammar"

66d28a6

This reverts commit 8fc5412.

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

Merge branch 'master' into patch-1

8121bc1

Secrus approved these changes Jul 7, 2023

View reviewed changes

Merge branch 'master' into patch-1

a39c681

Secrus merged commit 8437d54 into python-poetry:master Jul 7, 2023
18 checks passed

radoering mentioned this pull request Aug 20, 2023

release: bump version to 1.6.0 #8333

Merged

github-actions bot locked as resolved and limited conversation to collaborators Mar 3, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

MicaelJarniac commented Jun 30, 2023 •

edited

dimbleby commented Jun 30, 2023 •

edited

Secrus commented Jun 30, 2023

MicaelJarniac commented Jun 30, 2023 •

edited

MicaelJarniac commented Jul 3, 2023

github-actions bot commented Mar 3, 2024

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

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

Conversation

MicaelJarniac commented Jun 30, 2023 • edited

dimbleby commented Jun 30, 2023 • edited

Secrus commented Jun 30, 2023

MicaelJarniac commented Jun 30, 2023 • edited

MicaelJarniac commented Jul 3, 2023

github-actions bot commented Mar 3, 2024

MicaelJarniac commented Jun 30, 2023 •

edited

dimbleby commented Jun 30, 2023 •

edited

MicaelJarniac commented Jun 30, 2023 •

edited