chore!: remove vendor from repo and cleanup zip. (#73)

* chore!: remove `vendor` from repo and cleanup zip.

* chore: update readme

Author: justlevine

.distignore

@@ -9,9 +9,7 @@
 /docker
 /docker-output
 /docs
-/img
 /phpstan
-/plugin-build
 /tests
 
 .coveralls.yml
@@ -20,18 +18,16 @@
 .DS_Store
 .env
 .env.dist
-.gitattributes
 .gitignore
 .phpcs.xml
 .phpcs.xml.dist
-.travis.yml
 CHANGELOG.md
 codeception.dist.yml
 codeception.yml
 composer.json
 composer.lock
 docker-compose.yml
 phpstan.neon.dist
-phpunit.xml.dist
+phpstan.neon
 README.md
 schema.graphql

.gitattributes

@@ -21,13 +21,13 @@ jobs:
           tools: composer
 
       - name: Install dependencies
-        run: |
-          composer install --no-dev --optimize-autoloader
+        uses: ramsey/composer-install@v3
+        with:
+          composer-options: "--no-progress --no-dev --optimize-autoloader"
 
-      - name: Create Artifact
+      - name: Build and zip
         run: |
-          mkdir plugin-build
-          composer archive -vvv --format=zip --file="plugin-build/wp-graphql-facetwp"
+          composer run-script zip
 
       - name: Upload artifact
         uses: actions/upload-artifact@v4

.github/workflows/upload-release.yml

@@ -25,11 +25,10 @@ plugin-build
 auth.json
 
 # Composer deps
-!vendor
+vendor
+!vendor-prefixed
 vendor/*
-!vendor/autoload.php
-!vendor/composer
-vendor/composer/*/
+!vendor-prefixed/.gitkeep
 
 # NPM deps
 node_modules

.gitignore

@@ -2,7 +2,9 @@
 
 ## [Unreleased]
 
+- chore!: Remove `vendor` and `vendor-prefixed/*` from the GitHub repository.
 - chore: Update Strauss to v0.19.1 and Composer dependencies.
+- ci: Cleanup zip and release workflow.
 
 ## v0.5.0
 

CHANGELOG.md

@@ -24,13 +24,19 @@ This plugin has been tested and is functional with SearchWP.
 * PHP 7.4-8.1.x
 * WordPress 5.4.1+
 * WPGraphQL 1.6.0+ (1.9.0+ recommended)
-* FacetWP 4.0
+* FacetWP 4.0+
 
 ## Quick Install
 
 1. Install & activate [WPGraphQL](https://www.wpgraphql.com/).
 2. Install & activate [FacetWP](https://facetwp.com/).
-3. Download the [latest release](https://github.com/hsimah-services/wp-graphql-facetwp/releases) `.zip` file, upload it to your WordPress install, and activate the plugin.
+3. Download the `wp-graphql-facetwp.zip` file from the [latest release](https://github.com/hsimah-services/wp-graphql-facetwp/releases/latest) upload it to your WordPress install, and activate the plugin.
+
+> [!IMPORTANT]
+>
+> Make sure you are downloading the [`wp-graphql-facetwp.zip`](https://github.com/hsimah-services/wp-graphql-facetwp/releases/latest/download/wp-graphql-facetwp.zip) file from the releases page, not the `Source code (zip)` file nor a clone of the repository.
+>
+> If you wish to use the source code, you will need to run `composer install` inside the plugin folder to install the required dependencies.
 
 ### With Composer
 

README.md

@@ -28,7 +28,7 @@
 	"readme": "README.md",
 	"funding": [
 		{
-			"type":"github",
+			"type": "github",
 			"url": "https://github.com/sponsors/AxeWP"
 		}
 	],
@@ -91,7 +91,7 @@
 		"phpstan/phpstan": "^1.8",
 		"phpstan/extension-installer": "^1.1",
 		"szepeviktor/phpstan-wordpress": "^1.1",
-		"wp-graphql/wp-graphql-testcase": "~3.0.1",
+		"wp-graphql/wp-graphql-testcase": "~3.3.0",
 		"axepress/wp-graphql-stubs": "^1.13",
 		"axepress/wp-graphql-cs": "^2.0.0-beta",
 		"wp-cli/wp-cli-bundle": "^2.8.1",
@@ -140,26 +140,11 @@
 			"vendor/bin/phpstan analyze --ansi --memory-limit=1G"
 		]
 	},
-	"archive": {
-		"name": "wp-graphql-facetwp",
-		"exclude": [
-			"/.*",
-			"!.wordpress-org",
-			"bin",
-			"docker",
-			"docs",
-			"phpstan",
-			"plugin-build",
-			"tests",
-			"!vendor",
-			"/codeception.dist.yml",
-			"/codeception.yml",
-			"/composer.json",
-			"/composer.lock",
-			"/docker-compose.yml",
-			"/phpstan.neon.dist",
-			"/phpunit.xml.dist",
-			"/README.md"
-		]
-	}
+	"zip": [
+		"composer install --no-dev --optimize-autoloader",
+		"mkdir -p plugin-build/wp-graphql-facetwp",
+		"rsync -rc --exclude-from=.distignore --exclude=plugin-build . plugin-build/wp-graphql-facetwp/ --delete --delete-excluded -v",
+		"cd plugin-build ; zip -r wp-graphql-facetwp.zip wp-graphql-facetwp",
+		"rm -rf plugin-build/wp-graphql-facetwp/"
+	]
 }