Repository navigation
Adopt the wpgenius plugin standard and commit bundled libraries - #23
Merged
Merged
Conversation
Brings StackFolio up to the wpgenius plugin standard (from `wpgenius/wordpress-plugin-boilerplate` at `8e5e3a3`) and fixes the bundled libraries missing from the repo. ## Changes ### #13 Standard ignore files - `.gitignore` and `.distignore` are the standard's, followed by StackFolio's own rules. - `.distignore` keeps `blocks/` in the zip. The block is plain JavaScript with no build step, so `blocks/album-grid/` is runtime code, not source. ### #14 Automatic releases - `release.yml` and `.github/scripts/` copied as-is. `readme.txt` already had `Stable tag: 1.0.0` and a Changelog section. ### #15 Deploy workflow (WordPress.org SVN, off by default) - `deploy.yml` copied as-is. Repo variables: `DEPLOY_METHOD=wporg`, `DEPLOY_ENABLED=false`. ### #16 Linked issue check on PRs - `linked-issue.yml` copied as-is. `REQUIRE_LINKED_ISSUE=true`. ### #17 Dependabot for GitHub Actions - `.github/dependabot.yml` copied as-is. ### #18 GitHub setup script - `bin/setup-github.sh` copied as-is and run once: squash-only merges, release labels, private vulnerability reporting, the `release-bot` deploy key and the "Protect main" ruleset (Linked issue and CI required). ### #19 Tooling: CI, coding standards, PHPStan and local Docker - `ci.yml` adapted to StackFolio. Jobs: PHP 7.4–8.5 syntax and unit tests, PHPCS, PHPStan (level 5), JS/CSS lint, Plugin Check. No block-build, integration-test or rename jobs, since StackFolio has none of those. - `composer.json`, `phpcs.xml.dist` (`stackfolio` text domain and prefixes, `assets/vendor/` excluded), `phpstan.neon.dist` with Elementor stubs, `phpunit.xml.dist`, and unit tests for video-link parsing and album ID parsing. - `package.json` with lint scripts only. - Local Docker: `docker-compose.yml`, `.docker/`, `.env.example`, `.nvmrc`. - Lint fixes in StackFolio's JS and CSS: formatting, `var` → `const`/`let`, and small tidy-ups. Two PHPStan type fixes (casts to string, no `strlen` callback). ### #20 Community files - `CONTRIBUTING.md` (adapted to StackFolio's layout and checks), `SECURITY.md`, bug and feature issue forms, and a PR template. ### #21 Playground demo - `.wordpress-org/blueprints/blueprint.json`: installs the latest release with six sample albums (photos, a YouTube and a Vimeo video) and a demo page using the block. - "Try it in your browser" link in the README, plus a "How changes ship" section. ### #22 Bundled lightGallery, Isotope and Vimeo player files are missing from the repo - Commits `assets/vendor/`. The old `.gitignore` rule `vendor/` had hidden these files, so `main` had no lightbox or filter libraries. The standard `.gitignore` only ignores the root `/vendor/`. ## Verification - `bash -n` on every `.github/scripts/*.sh` and `bin/setup-github.sh` (actionlint is not installed locally). - `php -l` on all PHP files. - Locally: `composer lint`, `composer test` (18 tests), PHPCS and PHPStan (no errors), and ESLint and Stylelint via `wp-scripts` (clean, run on Node 22.20). - Package preview: main file, `blocks/`, `includes/`, `assets/` including `assets/vendor/`, `readme.txt`, `uninstall.php`, `LICENSE`. No dev files, no symlinks. - Built an exact copy of the package and ran the demo blueprint against it on WordPress Playground. The demo page renders six albums, filters work, and the lightbox opens with no console errors. On the album edit screen, the media list remove, reorder and picker all work. ## What happens on merge - The repo has no `vX.Y.Z` tags yet (only the old `v1.0-alpha1.0` and `v1.0-beta.1`, which the release workflow ignores), so this merge publishes **v1.0.0** ("Initial release") with `stackfolio.zip`. - Deploys stay off until `DEPLOY_ENABLED=true`. Closes #13 Closes #14 Closes #15 Closes #16 Closes #17 Closes #18 Closes #19 Closes #20 Closes #21 Closes #22
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Brings StackFolio up to the wpgenius plugin standard (from
wpgenius/wordpress-plugin-boilerplateat8e5e3a3) and fixes the bundled libraries missing from the repo.Changes
#13 Standard ignore files
.gitignoreand.distignoreare the standard's, followed by StackFolio's own rules..distignorekeepsblocks/in the zip. The block is plain JavaScript with no build step, soblocks/album-grid/is runtime code, not source.#14 Automatic releases
release.ymland.github/scripts/copied as-is.readme.txtalready hadStable tag: 1.0.0and a Changelog section.#15 Deploy workflow (WordPress.org SVN, off by default)
deploy.ymlcopied as-is. Repo variables:DEPLOY_METHOD=wporg,DEPLOY_ENABLED=false.#16 Linked issue check on PRs
linked-issue.ymlcopied as-is.REQUIRE_LINKED_ISSUE=true.#17 Dependabot for GitHub Actions
.github/dependabot.ymlcopied as-is.#18 GitHub setup script
bin/setup-github.shcopied as-is and run once: squash-only merges, release labels, private vulnerability reporting, therelease-botdeploy key and the "Protect main" ruleset (Linked issue and CI required).#19 Tooling: CI, coding standards, PHPStan and local Docker
ci.ymladapted to StackFolio. Jobs: PHP 7.4–8.5 syntax and unit tests, PHPCS, PHPStan (level 5), JS/CSS lint, Plugin Check. No block-build, integration-test or rename jobs, since StackFolio has none of those.composer.json,phpcs.xml.dist(stackfoliotext domain and prefixes,assets/vendor/excluded),phpstan.neon.distwith Elementor stubs,phpunit.xml.dist, and unit tests for video-link parsing and album ID parsing.package.jsonwith lint scripts only.docker-compose.yml,.docker/,.env.example,.nvmrc.var→const/let, and small tidy-ups. Two PHPStan type fixes (casts to string, nostrlencallback).#20 Community files
CONTRIBUTING.md(adapted to StackFolio's layout and checks),SECURITY.md, bug and feature issue forms, and a PR template.#21 Playground demo
.wordpress-org/blueprints/blueprint.json: installs the latest release with six sample albums (photos, a YouTube and a Vimeo video) and a demo page using the block.#22 Bundled lightGallery, Isotope and Vimeo player files are missing from the repo
assets/vendor/. The old.gitignorerulevendor/had hidden these files, somainhad no lightbox or filter libraries. The standard.gitignoreonly ignores the root/vendor/.Verification
bash -non every.github/scripts/*.shandbin/setup-github.sh(actionlint is not installed locally).php -lon all PHP files.composer lint,composer test(18 tests), PHPCS and PHPStan (no errors), and ESLint and Stylelint viawp-scripts(clean, run on Node 22.20).blocks/,includes/,assets/includingassets/vendor/,readme.txt,uninstall.php,LICENSE. No dev files, no symlinks.What happens on merge
vX.Y.Ztags yet (only the oldv1.0-alpha1.0andv1.0-beta.1, which the release workflow ignores), so this merge publishes v1.0.0 ("Initial release") withstackfolio.zip.DEPLOY_ENABLED=true.Closes #13
Closes #14
Closes #15
Closes #16
Closes #17
Closes #18
Closes #19
Closes #20
Closes #21
Closes #22