1.8 KiB
1.8 KiB
HOWTO_INITIALIZE.md
This repository is a Dynamic Template. Instead of manually deleting files or renaming folders, use the integrated Gitea Actions to scaffold your specific environment.
🚀 Getting Started
Follow these steps to initialize your project structure, documentation, and licensing:
- Navigate to Actions: Click on the Actions tab at the top of this repository.
- Select Workflow: On the left sidebar, select "Project Scaffolding (Advanced)".
- Run Workflow: Click the "Run workflow" dropdown menu on the right.
⚙️ Configuration Options
| Input | Description |
|---|---|
| Confirm Overwrite | Mandatory. You must check this box to allow the script to modify the repository. |
| Dry Run | Default: Enabled. Runs the script in simulation mode. Check the logs to see what would happen without making changes. |
| Project Language | Select your stack (Python, Node, C++, etc.) to fetch the appropriate .gitignore and boilerplate. |
🛡️ Safety Features
The Safety Switch
To prevent accidental data loss on existing projects, the automation will fail immediately unless the confirm_overwrite checkbox is active. This ensures that a "misclick" in the UI doesn't wipe your README.md.
Dry Run Mode
It is highly recommended to run the workflow with Dry Run enabled first.
- In Dry Run: The action logs will display
[DRY RUN] Would execute: mkdir -p src. - In Production: Once you are satisfied with the simulated output, uncheck Dry Run and run the workflow again to commit the files to
main.
📂 Standardized Structure
Once initialized, your repository will inherit a hierarchy based on the structure you chose from. If you are unsure about your choice, use the Dry Run mode.