Simplify build process by removing built site from version control

Previously, the site was served via the `docs` folder checked into
version control.  This required building the site and checking it in
every time anything changed.

This commit changes this process by removing the built site from version
control in favor of building and deploying it on each merge to main.

It is still possible to build and preview the site locally.  The only
difference is the site is built into and served from the "dist" folder
instead of the "docs" folder, using a much more predictable folder name.

Author: cookieguru

.dockerignore

@@ -2,10 +2,9 @@
 .github
 vendor
 node_modules
-docs
+dist
 .dockerignore
 Dockerfile
 docker-compose.yml
 .gitignore
-.gitattributes
 README.md

.gitattributes

@@ -0,0 +1,49 @@
+on:
+    push:
+        branches:
+            - main
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+
+        steps:
+            -   name: Checkout
+                uses: actions/checkout@v4
+
+            -   name: Setup PHP
+                uses: shivammathur/setup-php@v2
+                with:
+                    php-version: 8.3
+
+            -   name: Install PHP dependencies
+                run: composer install
+
+            -   name: Build website
+                run: composer build
+
+            -   name: Setup GitHub Pages
+                uses: actions/configure-pages@v4
+
+            -   name: Upload built site
+                uses: actions/upload-pages-artifact@v3
+                with:
+                    path: './dist'
+
+    deploy:
+        needs: build
+
+        permissions:
+            pages: write
+            id-token: write
+
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Deploy to GitHub Pages
+              id: deployment
+              uses: actions/deploy-pages@v4

.github/workflows/build-check.sh

@@ -2,4 +2,5 @@
 .DS_Store
 .phpunit.cache/
 .phpunit.result.cache
+dist
 vendor

.github/workflows/build-check.yml

@@ -37,7 +37,7 @@ build-site: build
 
 # Serve the site
 serve: build
-	docker run --rm -p $(HOST_PORT):$(CONTAINER_PORT) -v $(PWD):/var/www/html --name $(CONTAINER_NAME) $(IMAGE_NAME) php -S 0.0.0.0:$(CONTAINER_PORT) -t docs/
+	docker run --rm -p $(HOST_PORT):$(CONTAINER_PORT) -v $(PWD):/var/www/html --name $(CONTAINER_NAME) $(IMAGE_NAME) php -S 0.0.0.0:$(CONTAINER_PORT) -t dist/
 
 # Run tests
 test: build

.github/workflows/static-deploy.yml

@@ -35,7 +35,7 @@ Next, build the site by running
 composer build
 ```
 **Important:** You _must_ run build every time you are changing meetup data or any files in the
-`public` or `templates` directories.  This will re-generate the `docs` directory.  Verboseness
+`public` or `templates` directories.  This will re-generate the `dist` directory.  Verboseness
 can be controlled with `-v` to `-vvv` switches
 
 To view the site:
@@ -71,15 +71,9 @@ composer test
 
 Directory structure
 -------------------
-### docs
-The live copy of the site is here.  It _is_ under version control because GitHub pages serves
-the site directly from this folder.  Do not add or modify any files in this directory by hand;
-any changes will be lost in the next build.
-
-If you make changes to any files, the changes to the `docs` directory must be **in the same commit**.
-
-Note: `dist` would be a better name for this folder, but [due to GitHub limitations][1] it must
-be named docs.
+### dist
+The live copy of the site is here once built.  It is not under version control; if you need to
+update the site you should update files in one of the other directories below.
 
 ### public
 Files that need to be available on the live site (for example images and stylesheets) are in
@@ -100,6 +94,3 @@ Other
 Sculpin proved not to be customizable enough with regard to custom archive pages.
 No other static site generators offered a featureset comparable Sculpin or what has been built
 in this project.
-
-
-[1]: https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#about-publishing-sources

.gitignore

@@ -40,7 +40,7 @@
 		"lint": "phpcs",
 		"serve": [
 			"Composer\\Config::disableProcessTimeout",
-			"php -S localhost:8000 -t docs/"
+			"php -S localhost:8000 -t dist/"
 		],
 		"test": "phpunit --colors=always --testdox tests"
 	},

Makefile

@@ -13,7 +13,7 @@
 $application = new Application();
 
 $application->add(new MeetupGeneratorCommand(new MeetupGeneratorService(__DIR__ . '/src/Meetup')));
-$application->add(new SiteBuilderCommand(__DIR__ . '/docs'));
+$application->add(new SiteBuilderCommand(__DIR__ . '/dist'));
 
 /** @noinspection PhpUnhandledExceptionInspection */
 $application->run();