Template Cleanup action

[outslept]

Description

Introduces Template Cleanup Workflow, which removes template-specific files and configurations when a new repository is created from this template. We need this because GitHub has no built-in functionality to exclude certain folders and files from the template repo

Related Issues

https://github.com/haydenbleasel/next-forge/issues/261 (The workflow code from the example in here)

Checklist

• [X] My code follows the code style of this project.
• [X] I have performed a self-review of my code.
• [ ] I have commented my code, particularly in hard-to-understand areas.
• [ ] I have updated the documentation, if necessary.
• [ ] I have added tests that prove my fix is effective or my feature works.
• [ ] New and existing tests pass locally with my changes.

Current behavior:

https://github.com/user-attachments/assets/a05cb28a-547d-4283-b78e-050d827def04

Expected behavior

https://github.com/user-attachments/assets/d67897ec-1f5a-45cc-9e69-d5de7fe598be

Additional Notes

It takes the list of files to delete from here https://github.com/haydenbleasel/next-forge/blob/main/scripts/init.js and deletes the scripts folder as well. "Initial commit" is the default commit message when you create a repo from a template.

My test repo with the workflow implemented is here: https://github.com/idkgene/next-forge-main

Possible improvement to consider

To override the first default message we can use something like this in a workflow (for example like in here - https://github.com/PaulRBerg/hardhat-template/blob/main/.github/workflows/use-template.yml)

      - name: "Update commit"
        uses: "stefanzweifel/git-auto-commit-action@v4"
        with:
          commit_message: "feat: initial commit"
          commit_options: "--amend"
          push_options: "--force"
          skip_fetch: true

Summary by CodeRabbit

• New Features
  • Introduced a new automated workflow for cleaning up template files in the repository.
• Improvements
  • Enhanced the release job trigger conditions to prevent execution on initial commits and skipped CI messages.

[vercel[bot]]

@idkgene is attempting to deploy a commit to the Hayden Bleasel Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai[bot]]

Walkthrough

The changes include modifications to an existing GitHub Actions workflow in .github/workflows/release.yml, enhancing the conditions for triggering a release job by excluding 'Initial commit' messages. Additionally, a new workflow file, .github/workflows/template-cleanup.yml, has been introduced to automate the cleanup of template files upon pushes to the main branch. This new workflow includes steps for checking out the repository, removing specified files, committing changes, and pushing them back to the main branch.

Changes

File Path	Change Summary
.github/workflows/release.yml	Modified release job trigger conditions to exclude commits with 'Initial commit'.
.github/workflows/template-cleanup.yml	Introduced a new workflow for cleaning up template files on pushes to the main branch.

Poem

In the garden of code, a cleanup we seek,
With branches that blossom, and workflows unique.
No more initial commits to trigger a fuss,
Just tidy templates, no need to discuss!
Hopping through changes, a joyful delight,
Our codebase is fresh, and everything's right! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between aab11851989505cf6ceebd491a05639ce6dacde1 and 0630ab540a494c7dd3dc6238d1238068155bbd7a.

📒 Files selected for processing (1)

• .github/workflows/template-cleanup.yml (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• .github/workflows/template-cleanup.yml

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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 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.