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