Make little changes

[blakeNaccarato]

EDIT: Leaving this open until last bits are complete. But it is getting bloated with checkboxes so new changes should be posted in #338.

This is a long-lived issue that will track little changes to be made to the template. Changes tracked here are not usually big enough for their own PR, so they can be batched with each other in occasional sprints.

[blakeNaccarato]

• Make sure black is bumped in pre-commit additional_dependencies for blacken-docs
• Try templating --py310-plus in pyupgrade based on minimum Python version stated in Copier config. See related Implement dynamic python version in isort config #131

[blakeNaccarato]

• Migrate launch.json to initializer template
• Migrate tasks.json to initializer template

[blakeNaccarato]

• Add bare pre-commit task above the pre-commit run --all-files

    {
      "label": "pre-commit",
      "type": "process",
      "command": "pwsh",
      "args": ["-Command", "pre-commit"],
      "problemMatcher": []
    },

[blakeNaccarato]

• Add stage all task

    {
      "label": "git: Stage all files",
      "type": "process",
      "command": "git",
      "args": ["add", "-A"],
      "problemMatcher": []
    },

[blakeNaccarato]

• Standardize all tasks to use pwsh then Command in args

[blakeNaccarato]

• Latest VSCode update, exclude venv from auto expanding files when stepping in

[blakeNaccarato]

• Actually add latest pre-commit hooks from boilerdata. Forgot to?

[blakeNaccarato]

• Use .markdownlint.yaml as in boilerdata with MD013 and MD041: false instead of VSCode settings
• Wrap all version numbers in double-quotes in pre-commit config
• Figure out why markdownlint-cli or markdownlint-cli2 aren't working as pre-commit hooks.

[blakeNaccarato]

• Change docs/index.md to look like this

```{include} ../README.md
:relative-docs: docs/
:relative-images:
```

[blakeNaccarato]

• Add "git-submodules": { "enabled": true }, to renovate.json.
• Move the first-time-only submodule addition step to a task executed by copier-python-init. Migrate those things out of setup.ps1 and update.ps1 and figure out a way for users to only pull the repo-approved version of typings.

[blakeNaccarato]

• Update copier-python-init with latest copier.yaml changes and more

[blakeNaccarato]

• Make sure submodule add is forced if necessary due to typings being gitignored

[blakeNaccarato]

• Remove git project manager from extension recommendations

[blakeNaccarato]

• Make templated test pass CI by making sure to use that import, over in copier-python-init.

[blakeNaccarato]

• Make bump template digest... message more meaningful, indicating that the template is also being bumped.

[blakeNaccarato]

• Change copier-python-init to inform the template from the submodule rather than the repo pull. Then add submodules pull action back to the workflow over in copier-python. This will be a cleaner, single source of truth solution.

[blakeNaccarato]

• Resolve weird thing where .gitmodules has a duplicate template entry added

[blakeNaccarato]

• Consider removing pull_request event from main.yml.jinja and see if that fixes the change detection always returning true when bumping template. If so, then !failure() can be brought back

[blakeNaccarato]

• Add copier -f -r $(git rev-parse HEAD:template) task

[blakeNaccarato]

• Template renovate.json on override_precommit to delegate pre-commit updates to the project repo

[blakeNaccarato]

• Add ./requirements.txt to the cache

[blakeNaccarato]

• Make bump.yml work on push to all branches.

[blakeNaccarato]

• Switch bump.yml back to main only. Otherwise it blocks automerge.

[blakeNaccarato]

• Conditionally run Remove-Item -Recurse -Force .venv in setup.ps1 only if .venv exists

[blakeNaccarato]

• Try Invoke-Expression or & instead of . in setup.ps1

[blakeNaccarato]

• Remove cicd_setup.sh from template initializer

[blakeNaccarato]

• Use explicit -- parameters in all Tasks and other automations.

[blakeNaccarato]

• Propagate the below warning suppression

See #319 (comment)

[blakeNaccarato]

• Prepend PYTHONWARNINGS multiple times in environment file

[blakeNaccarato]

• Leave explicit comment-fenced regions for PROJECT-SPECIFIC input from the user in most template/user-shared files to facilitate diffs

This is definitely needed. Extra .env keys keep getting clobbered because of this

Looks like

# * -------------------------------------------------------------------------------- * #
# * PROJECT-SPECIFIC
# * Bla bla bla bla bla

# * -------------------------------------------------------------------------------- * #
# * TEMPLATE-SPECIFIC
# * Bla bla bla bla bla

[blakeNaccarato]

• Filter this warning

C:\Users\naccara5\.local\pipx\venvs\copier\Lib\site-packages\plumbum\commands\base.py:207: ResourceWarning: unclosed file <_io.BufferedRandom name='C:\\Users\\naccara5\\AppData\\Local\\Temp\\tmpmtnoac7j'>
  p = self.popen(args, **kwargs)
ResourceWarning: Enable tracemalloc to get the object allocation traceback

[blakeNaccarato]

• Run ruff using NbQA against notebooks on save

https://github.com/nbQA-dev/nbQA

[blakeNaccarato]

• Have bump_precommit upgrade requirements*.txt when matching packages are bumped. Like with ruff

[blakeNaccarato]

• Run NbQA in pre-commit, but be sure to bump sub-deps manually like we do with blacken.

[blakeNaccarato]

- [ ] Introduce the all-contributors automation like nbQA has

https://github.com/nbQA-dev

MIGRATED

[blakeNaccarato]

• Try checking out the commit pushed by the dependent workflow No longer necessary.

In this example, a specific ref is checked out. Can we just supply the commit as an output of the bump job? Would need to be conditional on bumping.

- uses: actions/checkout@v3
  with:
    ref: ${{ github.event.pull_request.head.sha }}

[blakeNaccarato]

• Establish Renovate schedules, alternating between copier-python and derived repositories.

[blakeNaccarato]

• Create Task to just re-run the template copy operation, allowing for different answers

copier -r "$(git rev-parse HEAD:template)"

[blakeNaccarato]

• Add fences to pre-commit-config.yaml, setup.ps1, and update.ps1

[blakeNaccarato]

• Exclude frozen_requirements.txt from dependency bumping
• Fix the excluded dependencies for pre-commit-config.yaml not working

[blakeNaccarato]

• Template Python version in this file

https://github.com/blakeNaccarato/copier-python/blob/main/template/.sourcery.yaml.jinja#L7

• Stop templating pre-commit-config.yaml and pyrightconfig.json

[blakeNaccarato]

• Propagate warnings to pytest.ini

[blakeNaccarato]

• Don't warn on unnecessary type ignores in CI

This would decouple the back-and-forth

[blakeNaccarato]

• Add an action to re-update the template on the current commit, without bumping. Don't copy, update.

[blakeNaccarato]

• Add task to re-compose pyproject.toml

[blakeNaccarato]

• Use importlib import mode for pytest

[blakeNaccarato]

• Use built-in black[jupyter] support over nbqa

https://github.com/psf/black#installation

[blakeNaccarato]

• Look into Frontmatter extension

[blakeNaccarato]

All done!