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

add: rename project to rockervsc #3

Merged
merged 2 commits into from
Sep 16, 2024
Merged

add: rename project to rockervsc #3

merged 2 commits into from
Sep 16, 2024

Conversation

blooop
Copy link
Owner

@blooop blooop commented Sep 16, 2024

Summary by Sourcery

Rename the project from 'python_template' to 'rockervsc' throughout the codebase, including documentation, configuration files, scripts, and code imports.

Enhancements:

  • Rename the project from 'python_template' to 'rockervsc' across various files including README, configuration files, scripts, and code imports.

Documentation:

  • Update documentation references to reflect the new project name 'rockervsc'.

Copy link

sourcery-ai bot commented Sep 16, 2024

Reviewer's Guide by Sourcery

This pull request renames the project from 'python_template' to 'rockervsc'. The changes are implemented by updating the project name in various files throughout the repository, including configuration files, documentation, and source code.

File-Level Changes

Change Details Files
Rename project in README.md
  • Update project title
  • Modify CI status badges with new project name
  • Update reference to dependency file name
README.md
Update project name in documentation configuration
  • Change project name in metadata version retrieval
  • Update autoapi directory path
docs/conf.py
Modify project renaming script
  • Update file names in move commands
  • Adjust sed command to replace new project name
scripts/rename_project.sh
Update DevContainer configuration
  • Change container name to 'rockervsc'
.devcontainer/devcontainer.json
Update changelog
  • Rename project in changelog header
CHANGELOG.md
Update import statements in code
  • Modify import statement in example file
  • Update import statement in test file
example/example.py
test/test_basic.py

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @blooop - I've reviewed your changes and found some issues that need to be addressed.

Blocking issues:

  • Hardcoded token found in Codecov badge URL. (link)
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🔴 Security: 1 blocking issue
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.


# change project name in all files
find . \( -type d -name .git -prune \) -o \( -type f -not -name 'tasks.json' -not -name 'update_from_template.sh' \) -print0 | xargs -0 sed -i "s/python_template/$1/g"
find . \( -type d -name .git -prune \) -o \( -type f -not -name 'tasks.json' -not -name 'update_from_template.sh' \) -print0 | xargs -0 sed -i "s/rockervsc/$1/g"
Copy link

Choose a reason for hiding this comment

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

suggestion: Consider improving the sed command to handle case variations in project name replacement

The current sed command only replaces exact matches of the project name. To make it more robust, you could use case-insensitive matching or include variations of the project name (e.g., uppercase, lowercase, camel case). This would ensure all instances of the project name are replaced, regardless of their case.

Suggested change
find . \( -type d -name .git -prune \) -o \( -type f -not -name 'tasks.json' -not -name 'update_from_template.sh' \) -print0 | xargs -0 sed -i "s/rockervsc/$1/g"
find . \( -type d -name .git -prune \) -o \( -type f -not -name 'tasks.json' -not -name 'update_from_template.sh' \) -print0 | xargs -0 sed -i -E "s/rockervsc/$1/gI; s/rocker[_-]?vsc/$1/gI; s/[Rr]ocker[Vv][Ss][Cc]/$1/g"

README.md Outdated
[![GitHub release](https://img.shields.io/github/release/blooop/python_template.svg)](https://GitHub.com/blooop/python_template/releases/)
[![License](https://img.shields.io/github/license/blooop/python_template)](https://opensource.org/license/mit/)
[![Ci](https://github.com/blooop/rockervsc/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/blooop/rockervsc/actions/workflows/ci.yml?query=branch%3Amain)
[![Codecov](https://codecov.io/gh/blooop/rockervsc/branch/main/graph/badge.svg?token=Y212GW1PG6)](https://codecov.io/gh/blooop/rockervsc)
Copy link

Choose a reason for hiding this comment

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

🚨 issue (security): Hardcoded token found in Codecov badge URL.

The token 'Y212GW1PG6' appears to be hardcoded in the Codecov badge URL. Consider using an environment variable or a secure method to handle this token.

@blooop blooop merged commit bba915e into main Sep 16, 2024
5 checks passed
@blooop blooop deleted the feature/rename branch September 16, 2024 09:15
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.

1 participant