forked from mfulz_github/qmk_firmware
Update maintenance scripts to add targets to validate the current branch for complete correctness. Add maintenance script target for checking for release suitability.
This commit is contained in:
parent
663f9bd5f5
commit
8de8d7ab5a
Maintenance
|
@ -12,6 +12,8 @@ LUFA_ROOT = ../
|
||||||
|
|
||||||
all:
|
all:
|
||||||
|
|
||||||
|
|
||||||
|
# Update all Doxygen configuration files to the latest Doxygen version - force Markdown support to be disabled
|
||||||
upgrade-doxygen:
|
upgrade-doxygen:
|
||||||
@echo Upgrading Doxygen.conf files...
|
@echo Upgrading Doxygen.conf files...
|
||||||
@for doxygen_conf in `find $(LUFA_ROOT) -name Doxygen.conf`; do \
|
@for doxygen_conf in `find $(LUFA_ROOT) -name Doxygen.conf`; do \
|
||||||
|
@ -21,7 +23,14 @@ upgrade-doxygen:
|
||||||
done;
|
done;
|
||||||
@echo Doxygen configuration update complete.
|
@echo Doxygen configuration update complete.
|
||||||
|
|
||||||
check-release:
|
# Validate the working branch - compile all documentation, demos/projects/examples and run build tests
|
||||||
|
validate-branch:
|
||||||
|
make -s -C $(LUFA_ROOT) doxygen
|
||||||
|
make -s -C $(LUFA_ROOT) all
|
||||||
|
make -s -C $(LUFA_ROOT)/BuildTests all
|
||||||
|
|
||||||
|
# Check the working branch documentation, ensure no placeholder values
|
||||||
|
check-documentation-placeholders:
|
||||||
@echo Checking for release suitability...
|
@echo Checking for release suitability...
|
||||||
@if ( grep "XXXXXX" $(LUFA_ROOT)/LUFA/DoxygenPages/*.txt > /dev/null ;); then \
|
@if ( grep "XXXXXX" $(LUFA_ROOT)/LUFA/DoxygenPages/*.txt > /dev/null ;); then \
|
||||||
echo " ERROR: Doxygen documentation has not been updated for release!"; \
|
echo " ERROR: Doxygen documentation has not been updated for release!"; \
|
||||||
|
@ -32,3 +41,6 @@ check-release:
|
||||||
exit 1; \
|
exit 1; \
|
||||||
fi;
|
fi;
|
||||||
@echo Done.
|
@echo Done.
|
||||||
|
|
||||||
|
# Validate the working branch for general release, check for placeholder documentation then build and test everything
|
||||||
|
validate-release: check-documentation-placeholders validate-branch
|
Loading…
Reference in New Issue