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.

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

514-make linting optional #568

Merged
merged 6 commits into from
Aug 27, 2024
Merged

514-make linting optional #568

merged 6 commits into from
Aug 27, 2024

Conversation

fdiblen
Copy link
Member

@fdiblen fdiblen commented Aug 26, 2024

Description

This PR makes linting integration optional.

Related issues:

Install the requirements

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

Test 1:

Step-1:
Run the command below and say 'yes' to Add linting? question

copier copy --vcs-ref 514_linting https://github.com/nlesc/python-template test_yes

Step-2:
Run the command below and say 'no' to Add linting? question

copier copy --vcs-ref 514_linting https://github.com/nlesc/python-template test_no

What to check:

  • You should see the files below only when you say 'yes':
    • .github/workflows/next_steps_linting.yml
    • .github/workflows/next_steps_linting_issue.md
  • Check if there are mentions of linting or linter in any file of the generated package.

Test 2:

  • Push the generated package to a GitHub repository
  • Check if next_steps_linting.yml workflow runs
  • Check if next_steps_linting.yml workflow is removed after a successful run
  • Check if a GitHub issue about linting is created

@fdiblen fdiblen changed the title 514-add linting next step as a question 514-make linting optional Aug 26, 2024
@fdiblen fdiblen marked this pull request as ready for review August 27, 2024 10:04
@fdiblen fdiblen mentioned this pull request Aug 27, 2024
3 tasks
Copy link
Contributor

@sjvrijn sjvrijn left a comment

Choose a reason for hiding this comment

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

Looks good to me 👍

Copy link
Member

@lyashevska lyashevska left a comment

Choose a reason for hiding this comment

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

Works as expected!

@fdiblen fdiblen merged commit 44b8c5b into main Aug 27, 2024
18 checks passed
@fdiblen fdiblen deleted the 514_linting branch August 27, 2024 11:17
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.

3 participants