Repository navigation
docs: refresh the README - #15
Merged
Merged
Conversation
license.txt was a leftover from Themosis (its own name and copyright in the appendix). LICENSE now holds the unmodified GPL-2.0 text from gnu.org, the package script leaves both names alone, and package.json declares the same SPDX id as style.css.
…cts their own README GitHub shows .github/README.md before the root one, and the scaffolder's File::allFiles() skips dot-directories, so the showcase stays on GitHub and the root README, with placeholders, becomes the generated project's guide.
The rsync now leaves README.md, .github/ and the license files alone (with --delete it removed .github/ and its workflows), the sed loop and leak check skip .github/ and bin/ (they rewrote the template's own tests), and the package.json license is set back after the sync.
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
1 participant
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.
Two READMEs.
.github/README.mdis the GitHub showcase (GitHub shows it before the root one). The scaffolder copies withFile::allFiles(), which skips dot-directories (checked), so it never reaches users. The rootREADME.mdis the generated project's own guide: placeholders thatmake:theme/make:pluginfill in (checked againstbin/replacements.php: no placeholder left), what's inside, the commands, links to pollora.dev. No banner, no org footer.Packaging. The rsync now leaves
/README.md,/.github/,/LICENSEand/license.txtalone. Before this,--deletewould have removed.github/and its workflows, because the dev copies have none. Thepackage.jsonlicense is set back after the sync, and the sed loop and leak check skip.github/.Showcase: banner, badges, screenshot. Installation via
--repository=Pollora/theme-apiaryor "E-commerce". Requirements fixed: PHP 8.4+ / WordPress 7.1+ for a new project; WooCommerce 10.3+ (the newest template override@version; CI runs the latest release); Node 20.19+/22.12+. They used to say PHP 8.1 / WP 6.0 / WC 8.0 / Node 18. Counts fixed (130 views, 12 menu locations); structure and config table completed.License:
LICENSEholds the unmodified GPL-2.0 text and replaceslicense.txt, a Themosis leftover.package.jsondeclares GPL-2.0-or-later, set back after each packaging run.Also: the sed loop now skips
bin/. Packaging was rewriting the theme's own CI specs (bin/tests/e2e/editor.spec.ts,sweep.php:apiary/ci-dynamicbecame%theme_name%/ci-dynamic).Checked:
php bin/tests/design-system.phppasses. A packaging run from the localapiarycopy succeeds and leaves README, .github, LICENSE and bin untouched. No tag.