Readme update

[ejfine]

Link to Issue or Message thread

#71

Why is this change necessary?

Missing a step in readme about staging the changes

How does this change address the issue?

Adds it

What side effects does this change have?

None

How is this change tested?

Downstream child and grandchild repos

Other

Bumps various versions, including a change in the name of copier-template-extensions

Summary by CodeRabbit

• Bug Fixes

  • Corrected package and extension names from "copier-templates-extensions" to "copier-template-extensions" across configuration and template files.
  • Fixed import paths and variable names related to copier template extensions.
  • Updated URLs in comments to reflect correct repository names.
  • Addressed minor formatting issue in workflow step names.

• Dependency Updates

  • Upgraded versions for several dependencies, including UV, Copier, copier-template-extensions, pytest, pulumi, pulumi_aws, pulumi_aws_native, pulumi_github, and boto3.

• Documentation

  • Improved setup instructions by adding a step to stage files with git add . after generating the lock file.

• Style

  • Added a lint rule to the ignore list in the linter configuration.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This update synchronizes several version numbers and corrects naming inconsistencies related to the "copier template extensions" package across code, configuration, and documentation files. Minor documentation and formatting improvements are included, along with a new instruction step for staging files during repository setup. No changes to control flow or exported entities were made.

Changes

File(s)	Change Summary
.devcontainer/devcontainer.json	Updated context hash comment.
.devcontainer/install-ci-tooling.py, extensions/context.py, pyproject.toml	Updated versions for UV, Copier, and Copier Template Extensions; fixed naming inconsistencies.
copier.yaml, template/extensions/context.py.jinja-base, template/pyproject.toml.jinja-base	Corrected package name and import paths for copier template extensions.
template/.devcontainer/install-ci-tooling.py.jinja-base	Renamed variable for copier template extensions version; updated install command string.
README.md, template/README.md.jinja-base	Added instruction to stage files (git add .) after lock file generation.
template/.github/workflows/pre-commit.yaml.jinja-base	Fixed formatting in step name (removed extra space).
ruff.toml	Added SIM114 to ignored lint rules with explanatory comment.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐇
Hopping through configs, I tidy each name,
Copier extensions—now spelled all the same.
Versions are freshened, the hashes align,
Docs get a polish, the instructions now shine.
With a git add hop, and a ruff rule or two,
This bunny’s work is nearly through!
✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 856bdf9 and 815b177.

⛔ Files ignored due to path filters (1)

• uv.lock is excluded by !**/*.lock

📒 Files selected for processing (12)

• .devcontainer/devcontainer.json (1 hunks)
• .devcontainer/install-ci-tooling.py (2 hunks)
• README.md (1 hunks)
• copier.yaml (1 hunks)
• extensions/context.py (2 hunks)
• pyproject.toml (1 hunks)
• ruff.toml (1 hunks)
• template/.devcontainer/install-ci-tooling.py.jinja-base (2 hunks)
• template/.github/workflows/pre-commit.yaml.jinja-base (1 hunks)
• template/README.md.jinja-base (1 hunks)
• template/extensions/context.py.jinja-base (2 hunks)
• template/pyproject.toml.jinja-base (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[Copilot]

Pull Request Overview

This PR updates the README with missing instructions for staging changes and updates package versions, including a package name change from copier-templates-extensions to copier-template-extensions.

• Adds a missing step in the README to stage files before committing
• Updates various package versions (uv, copier, pytest, pulumi packages, etc.)
• Renames copier-templates-extensions package to copier-template-extensions throughout the codebase

Reviewed Changes

Copilot reviewed 11 out of 13 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
README.md	Adds git staging step to setup instructions
template/README.md.jinja-base	Adds git staging step to template's setup instructions
pyproject.toml	Updates copier and package versions, renames extension package
template/pyproject.toml.jinja-base	Updates package name reference in template
extensions/context.py	Updates package versions and renames extension import
template/extensions/context.py.jinja-base	Updates extension import in template
.devcontainer/install-ci-tooling.py	Updates package versions and variable names
template/.devcontainer/install-ci-tooling.py.jinja-base	Updates package versions and variable names in template
copier.yaml	Updates extension reference in copier configuration
ruff.toml	Adds new ignore rule for SIM114
.devcontainer/devcontainer.json	Updates devcontainer hash