docs: update PackagingForCloudronWorkspace README to reflect new paths and simplified process

This commit is contained in:
2025-09-12 14:12:50 -05:00
parent 7a4748496c
commit 4677c5c3ff

View File

@@ -5,19 +5,19 @@ This workspace contains development tools and upstream source repositories for C
## 🏗️ Workspace Structure ## 🏗️ Workspace Structure
``` ```
CloudronPackagingWorkspace/ PackagingForCloudronWorkspace/
├── README.md # This file ├── README.md # This file
├── Docker/ (gitignored) # Upstream application sources (~56 apps) ├── Docker/ (gitignored) # Upstream application sources (many apps)
├── NonDocker/ (gitignored) # Non-Docker application sources ├── NonDocker/ (gitignored) # Non-Docker application sources
├── UpstreamVendor-Clone.sh # Clone all upstream repositories ├── UpstreamVendor-Clone.sh # Clone all upstream repositories
└── UpstreamVendor-Update.sh # Update existing repositories └── UpstreamVendor-Update.sh # Update existing repositories
``` ```
## 🚀 Setup Instructions ## 🚀 Setup Instructions
### Initial Setup ### Initial Setup
```bash ```bash
cd CloudronPackagingWorkspace/ cd PackagingForCloudronWorkspace/
# Create Docker directory for upstream sources # Create Docker directory for upstream sources
mkdir -p Docker mkdir -p Docker
@@ -29,7 +29,7 @@ chmod +x *.sh
./UpstreamVendor-Clone.sh ./UpstreamVendor-Clone.sh
``` ```
This will perform a clone of all upstream vendor software/Docker repositories for every application that KNEL is packaging for Cloudron deployment. This clones upstream vendor repositories used when packaging applications for Cloudron.
### Keeping Sources Updated ### Keeping Sources Updated
```bash ```bash
@@ -92,31 +92,26 @@ mkdir -p [appname]_package_new
## 📋 Workspace Management ## 📋 Workspace Management
### Adding New Applications ### Adding New Applications
1. Update `UpstreamVendor-Clone.sh` with new repository URL 1. Update `UpstreamVendor-Clone.sh` with the new repository URL
2. Run the clone script to fetch the new application 2. Run the clone script to fetch the new application
3. Add application to priority list in `TASKS.md`
### Removing Applications ### Removing Applications
1. Remove directory from `Docker/` 1. Remove directory from `Docker/`
2. Update clone script to prevent future re-cloning 2. Update clone script to prevent future re-cloning
3. Update task lists and documentation
### Repository Updates ### Repository Updates
- **Frequency**: Weekly or before starting new package development - Run `./UpstreamVendor-Update.sh` periodically or before starting packaging work
- **Method**: Run `./UpstreamVendor-Update.sh` - Check for breaking changes in upstream before building
- **Verification**: Check for breaking changes in upstream
## ⚠️ Important Notes ## ⚠️ Important Notes
### Git Exclusions ### Git Exclusions
- **Docker/**: All contents are gitignored - `Docker/` and `NonDocker/` are gitignored (see repo `.gitignore`)
- **NonDocker/**: All contents are gitignored - Keeps the repo slim while preserving local sources
- This keeps the main repository clean while preserving access to sources
### Repository Integrity ### Repository Integrity
- Never commit upstream sources to the main repository - Never commit upstream sources to the repository
- Use temporary directories for package development - Develop packages outside of `Docker/` (e.g., directly under `CloudronPackages/<AppName>`)
- Move final packages to `CloudronPackages/` when complete
### Source Licenses ### Source Licenses
- Each upstream repository maintains its own license - Each upstream repository maintains its own license
@@ -142,12 +137,9 @@ Edit scripts as needed to:
- Modify update behavior - Modify update behavior
- Handle special cases - Handle special cases
## 📊 Workspace Statistics ## 📊 Notes
- **Total Applications**: 56 repositories - Number of upstream repositories and size vary over time.
- **Repository Size**: ~2-3 GB total (varies by application)
- **Update Frequency**: Weekly recommended
- **Clone Time**: ~15-30 minutes for full clone
## 🤝 Team Usage ## 🤝 Team Usage
@@ -165,6 +157,4 @@ Edit scripts as needed to:
--- ---
**Last Updated**: 2025-01-04 **Maintained By**: KNEL/TSYS Development Team
**Maintained By**: KNEL/TSYS Development Team
**Part of**: [KNEL Production Containers](../README.md) packaging project