1
0
mirror of https://github.com/nisrulz/flutter-examples.git synced 2026-08-25 01:05:36 +00:00

make: add docs target to regenerate EXAMPLES.md

This commit is contained in:
Nishant Srivastava
2026-08-17 17:25:07 +02:00
parent f62d1fcf6e
commit c8d2d4fffc
2 changed files with 6 additions and 1 deletions

View File

@@ -1,6 +1,6 @@
SHELL := /bin/bash SHELL := /bin/bash
.PHONY: help packages clean-builds gradle-update .PHONY: help packages clean-builds gradle-update docs
help: ## Show available commands help: ## Show available commands
@echo "Available commands:" @echo "Available commands:"
@@ -9,6 +9,7 @@ help: ## Show available commands
@echo " make packages Run 'flutter packages get' for all apps" @echo " make packages Run 'flutter packages get' for all apps"
@echo " make clean-builds Move all build folders to trash" @echo " make clean-builds Move all build folders to trash"
@echo " make gradle-update Upgrade Gradle wrappers" @echo " make gradle-update Upgrade Gradle wrappers"
@echo " make docs Regenerate documentation/EXAMPLES.md"
@echo "" @echo ""
@echo "gradle-update options:" @echo "gradle-update options:"
@echo " VERSION=<x.y.z> Target Gradle version (default: latest from GitHub)" @echo " VERSION=<x.y.z> Target Gradle version (default: latest from GitHub)"
@@ -26,6 +27,9 @@ packages: ## Run flutter packages get for all apps
clean-builds: ## Move all build folders to trash clean-builds: ## Move all build folders to trash
./scripts/delete_build_folder.sh ./scripts/delete_build_folder.sh
docs: ## Regenerate documentation/EXAMPLES.md from app folders
./scripts/generate_examples_doc.sh
gradle-update: ## Upgrade Gradle wrappers gradle-update: ## Upgrade Gradle wrappers
@args=""; \ @args=""; \
if [ -n "$(VERSION)" ]; then args="--version $(VERSION)"; fi; \ if [ -n "$(VERSION)" ]; then args="--version $(VERSION)"; fi; \

View File

@@ -10,6 +10,7 @@ All maintenance commands are available through the `Makefile` at the repository
| `make packages` | Run `flutter packages get` for all example apps | | `make packages` | Run `flutter packages get` for all example apps |
| `make clean-builds` | Move all build folders to trash | | `make clean-builds` | Move all build folders to trash |
| `make gradle-update` | Upgrade Gradle wrappers to the latest version | | `make gradle-update` | Upgrade Gradle wrappers to the latest version |
| `make docs` | Regenerate `documentation/EXAMPLES.md` from the app folders |
## Update Gradle wrappers ## Update Gradle wrappers