Skip to content

Commit 1e34f88

Browse files
committed
πŸ“š Update README: Document intelligent change detection system
πŸ†• COMPREHENSIVE DOCUMENTATION UPDATE ## New Content Added: ### Intelligent Change Detection System - Documents YAML hash monitoring and remote repository tracking - Explains performance optimization (seconds vs minutes) - Details the new selective rebuild logic ### Updated Workflow Documentation - Enhanced Mermaid sequence diagram with change detection flow - Updated make targets with new utility commands - Added force-build options and cache management ### Technical Implementation Details - Documents check_changes.sh script functionality - Explains cache system (.cache/ directory) - Details GitHub API integration for remote monitoring ### Repository Mapping Documentation - digitalesysteme β†’ VL_EingebetteteSysteme - prozprog β†’ VL_ProzeduraleProgrammierung - softwareentwicklung β†’ VL_Softwareentwicklung - robotikprojekt β†’ VL_Robotikprojekt ### Troubleshooting Section - Common scenarios and solutions - Performance metrics and expectations - Remote repository update handling ### Updated File Structure - Documents new files: check_changes.sh, .cache/, .gitignore - Shows current PDF naming examples - Reflects improved Makefile capabilities ## Key Improvements: βœ… Comprehensive coverage of all new features βœ… Clear performance expectations documented βœ… Troubleshooting guide for common issues βœ… Technical details for maintenance and debugging βœ… Updated workflow diagrams and examples The README now fully reflects the production-ready intelligent build system with remote repository monitoring capabilities.
1 parent 9402e7e commit 1e34f88

120 files changed

Lines changed: 477 additions & 490 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

β€ŽMakefileβ€Ž

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ SCORM_ORG = "TU-Bergakademie Freiberg"
55
SCORM_SCORE = 80
66

77
.DEFAULT_GOAL := all
8-
all: $(COURSES)
8+
all: $(COURSES) git-update-if-needed
99

1010
# Generic function to build a course
1111
define build_course
@@ -17,7 +17,7 @@ $(1): $(1).yml
1717
echo "πŸ“„ Using existing $(1).html and assets"; \
1818
fi
1919

20-
force-build-$(1): clean-$(1) build-$(1) organize-$(1) git-update
20+
force-build-$(1): clean-$(1) build-$(1) organize-$(1) mark-changed
2121

2222
clean-$(1):
2323
@echo "🧹 Cleaning old files for $(1)..."
@@ -42,6 +42,21 @@ endef
4242
# Generate targets for all courses
4343
$(foreach course,$(COURSES),$(eval $(call build_course,$(course))))
4444

45+
mark-changed:
46+
@touch .cache/build_occurred
47+
48+
git-update-if-needed:
49+
@if [ -f .cache/build_occurred ]; then \
50+
echo "πŸ”„ Changes detected - updating git repository..."; \
51+
git add assets/ || true; \
52+
git add -A; \
53+
git commit --amend --no-edit; \
54+
git push origin main -f; \
55+
rm -f .cache/build_occurred; \
56+
else \
57+
echo "βœ… No courses rebuilt - git repository unchanged"; \
58+
fi
59+
4560
git-update:
4661
git add assets/ || true
4762
git add -A

β€ŽREADME.mdβ€Ž

Lines changed: 141 additions & 41 deletions
2.91 KB
Binary file not shown.
-6 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
-103 KB
Binary file not shown.
-12.1 KB
Binary file not shown.
-192 KB
Binary file not shown.
-528 Bytes
Binary file not shown.
57 Bytes
Binary file not shown.

0 commit comments

Comments
Β (0)