Skip to content

Remove --fix from ruff tests and update template#634

Merged
abelsiqueira merged 1 commit intomainfrom
580-ruff-check
Aug 29, 2024
Merged

Remove --fix from ruff tests and update template#634
abelsiqueira merged 1 commit intomainfrom
580-ruff-check

Conversation

@abelsiqueira
Copy link
Copy Markdown
Member

@abelsiqueira abelsiqueira commented Aug 29, 2024

Checklist before requesting a review

  • I have read the contribution guidelines
  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • All user facing changes have been added to CHANGELOG.md

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)

List of related issues or pull requests**

Refs:

Describe the changes made in this pull request

Running ruff check should pass without the --fix option.
This changes to test that verifies this and updates the files in the
template that would cause the test to fail. Namely, some single-quoted
strings were changed to double-quoted strings.

Instructions to review the pull request

Install the requirements

cd $(mktemp -d --tmpdir py-tmpl-XXXXXX)
pip install pipx
pipx install copier

Create a new package using the template

copier copy --vcs-ref <YOUR_BRANCH> https://github.com/nlesc/python-template test_package
# Create a local environment to test your generated package locally
python -m venv env
source env/bin/activate
python -m pip install --upgrade pip setuptools
python -m pip install '.[dev,publishing]'

Run the tests

pytest

Running `ruff check` should pass without the `--fix` option.
This changes to test that verifies this and updates the files in the
template that would cause the test to fail. Namely, some single-quoted
strings were changed to double-quoted strings.

Related to #580.
@abelsiqueira abelsiqueira marked this pull request as ready for review August 29, 2024 10:03
@abelsiqueira abelsiqueira requested a review from fdiblen August 29, 2024 11:05
Copy link
Copy Markdown
Member

@fdiblen fdiblen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice job @abelsiqueira. I tested it on a test repo and it works as expected.

🍰

@abelsiqueira abelsiqueira merged commit 1d506f3 into main Aug 29, 2024
@abelsiqueira abelsiqueira deleted the 580-ruff-check branch August 29, 2024 12:59
@abelsiqueira
Copy link
Copy Markdown
Member Author

Thanks for the review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants