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

feat: Migrate to Copier #1

Draft
wants to merge 23 commits into
base: main
Choose a base branch
from
Draft

feat: Migrate to Copier #1

wants to merge 23 commits into from

Conversation

pawamoy
Copy link
Member

@pawamoy pawamoy commented Feb 25, 2024 •
edited by bswck
Loading

Very rough PR. Still lots of things to be done:

  • Update file tree in docs work page
  • Document dependency management.
  • Design task system and document it.
  • Implement and document each check.
  • Design and implement bug report system.
  • Update environment variable name in CI workflow.
  • Fix instructions in CI workflow.
  • Setup Python to check MkDocs docs in CI workflow.
  • Add Zsh versions to the CI test matrix.
  • Update config/vscode/launch.json to use bats or Zsh equivalent.
  • Update script that generate credits to use Basher dependencies.
  • Update script that generate the reference navigation.
  • Update scripts/make, merge Makefile into it.

It's OK if tasks and CI do not work in this PR, we can fix them later in other PRs. I just want the template to generate a correct file tree, that can then be installed using Basher, and called from the CLI or sourced in scripts/libraries.

Closes shellm-org/cookiecutter-shellm#1.

@pawamoy pawamoy self-assigned this Feb 25, 2024
@pawamoy pawamoy requested a review from bswck February 25, 2024 13:59
bswck
bswck requested changes Feb 26, 2024
View reviewed changes
Copy link
Member

@bswck bswck left a comment

Choose a reason for hiding this comment

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

Since you requested my review, here it is. I'll get back to some of my points when I have time, probably tomorrow.

copier.yml Outdated Show resolved Hide resolved
extensions.py Outdated Show resolved Hide resolved
extensions.py Outdated Show resolved Hide resolved
Makefile Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
tests/test_filenames.sh Outdated Show resolved Hide resolved
project/tests/data.bash.jinja Outdated Show resolved Hide resolved
project/scripts/gen_ref_nav.py Outdated Show resolved Hide resolved
project/scripts/gen_credits.py.jinja Outdated Show resolved Hide resolved
project/scripts/gen_credits.py.jinja
@@ -0,0 +1,170 @@
"""Script to generate the project's credits."""
Copy link
Member

Choose a reason for hiding this comment

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

I'll refine typing here a bit, okay?

pawamoy and others added 21 commits February 26, 2024 17:17
@pawamoy @bswck
Update copier.yml
b605a16 
Co-authored-by: Bartosz Sławecki <[email protected]>
@pawamoy @bswck
Update extensions.py
eea94bb 
Co-authored-by: Bartosz Sławecki <[email protected]>
@pawamoy @bswck
Update tests/test_filenames.sh
45191c0 
Co-authored-by: Bartosz Sławecki <[email protected]>
@pawamoy @bswck
Update project/tests/data.bash.jinja
b0e65fc 
Co-authored-by: Bartosz Sławecki <[email protected]>
@pawamoy @bswck
Update project/scripts/gen_ref_nav.py
5147d50 
Co-authored-by: Bartosz Sławecki <[email protected]>
@pawamoy @bswck
Update Makefile
77092d4 
Co-authored-by: Bartosz Sławecki <[email protected]>
@pawamoy @bswck
Update Makefile
2f74d07 
Co-authored-by: Bartosz Sławecki <[email protected]>
@pawamoy @bswck
Update project/scripts/gen_credits.py.jinja
cbcfcf7 
Co-authored-by: Bartosz Sławecki <[email protected]>
@pawamoy @bswck
Update README.md
296fc5c 
Co-authored-by: Bartosz Sławecki <[email protected]>
@pawamoy @bswck
Update docs/requirements.md
999657d 
Co-authored-by: Bartosz Sławecki <[email protected]>
@pawamoy @bswck
Update docs/requirements.md
5b413d9 
Co-authored-by: Bartosz Sławecki <[email protected]>
@pawamoy @bswck
Update docs/work.md
476e181 
Co-authored-by: Bartosz Sławecki <[email protected]>
@pawamoy @bswck
Update tests/test_generate.sh
b7c6875 
Co-authored-by: Bartosz Sławecki <[email protected]>
@pawamoy @bswck
Update docs/work.md
029fa87 
Co-authored-by: Bartosz Sławecki <[email protected]>
@pawamoy
Apply suggestions
ea5ba2d
@pawamoy
Merge branch 'copier' of github.com:shellm-org/template into copier
f7c321c
@pawamoy @bswck
Update project/.github/ISSUE_TEMPLATE/bug_report.md.jinja
0fdf68f 
Co-authored-by: Bartosz Sławecki <[email protected]>
@pawamoy @bswck
Update project/.github/workflows/release.yml.jinja
08e999f 
Co-authored-by: Bartosz Sławecki <[email protected]>
@pawamoy @bswck
Update project/CONTRIBUTING.md.jinja
f8b78bf 
Co-authored-by: Bartosz Sławecki <[email protected]>
@pawamoy
Remove funding file
6aea92d
@pawamoy
Remove licenses folder since we already have a single templated licen…
aed37bc 
…se file
@pawamoy
Copy link
Member Author

pawamoy commented Feb 26, 2024

Thank you so much for your review! Please note that even if I request one from you, you have zero obligation to review, and it will never be urgent (unless explicitly mentioned), OK 😊 ?

I believe I have applied/addressed/commented everything!

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

@bswck bswck bswck requested changes

Assignees

@pawamoy pawamoy

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Migrate to copier
2 participants
@pawamoy @bswck