Feature/add more flexibility #413

dustinrue · 2024-07-05T22:38:11Z

Related Issue/RFC: None but all changes are related to the project sub command.

Description of the Change

Improves the init process to provide support for two different repository layouts. One rooted in wp-content and another more appropriate for mono repo setups. This is achieved with the use of a currently hidden option called --layout=modern
Updates the build system to support either repository layout automatically
Ports over a lot of logic to differentiate between a local and CI builds
Forces true environment variables to be passed to the downstream build scripts
Provides an example build script for people to build off of but builds are otherwise "free" when using this tool to perform builds.
Poorly rewrote create-payload.js to just be build.js with a different command sent to build backend. The payload is just a build put into a new directory and ready to be shipped off
Removed "deploy-excludes" in favor of "rsync-excludes".

Alternate Designs

Possible Drawbacks

Verification Process

Create repositories using the original design as well as updated design and then performed builds in each. Verified that builds for UIKit based projects complete with out any issue for both the build and create-payload commands.

Checklist:

I have read the CONTRIBUTING document.
My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have added tests to cover my change.
All new and existing tests passed.
I have added a changeset to my PR. See CONTRIBUTING document for instructions

changeset-bot · 2024-07-05T22:38:15Z

🦋 Changeset detected

Latest commit: 8587947

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
10up-toolkit	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

packages/toolkit/scripts/project/build.js

packages/toolkit/scripts/project/create-payload.js

packages/toolkit/scripts/project/init.js

…ocess

packages/toolkit/scripts/project/init.js

packages/toolkit/scripts/project/package.js

packages/toolkit/scripts/project/update-composer.js

…able; remove composer block that wasnt doing anything

…xibility-tl

… a option in the build command that lets you specify

…nt to bash including the proper WORDPRESS_VERSION

Feature/add more flexibility tl

packages/toolkit/scripts/project/build.js

packages/toolkit/scripts/project/init.js

-		}
-	});
+	// Copy contents of toolkitPath/project/local into cliPath
+	execSync(`rsync -rc "${toolkitPath}/project/local/" "${cliPath}"`);


packages/toolkit/scripts/project/init.js

+	process.chdir(cliPath);
+
+	if (template !== 'none' && !skipComposer) {
+		execSync(`bash -l ${__dirname}/bash/scripts.sh update-composer`, {


packages/toolkit/scripts/project/init.js

+		});
+	}
+
+	execSync(`bash -l ${__dirname}/bash/scripts.sh initialize-git`, {


packages/toolkit/scripts/project/package.js

+
+	setEnvVariables(variables);
+
+	execSync(`bash -l ${__dirname}/bash/scripts.sh package`, {


packages/toolkit/scripts/project/update-composer.js

+
+	setEnvVariables(variables);
+
+	execSync(`bash -l ${__dirname}/bash/scripts.sh update-composer`, {


packages/toolkit/scripts/project/build.js

-		log(chalk.red('No build script found.'));
-		process.exit(1);
-	}
+	execSync(`${process.env.SHELL} ${__dirname}/bash/scripts.sh ${buildType}`, {


commit 8b74e5a Author: Dustin Rue <[email protected]> Date: Wed Aug 21 14:36:32 2024 -0500 Feature/add more flexibility (#413) Co-authored-by: Taylor Lovett <[email protected]>

dustinrue added 3 commits July 5, 2024 13:46

fix deprecation warning, support a more modern layout

77c4063

fix typo in readme

cb6d5c9

improved init and build systems

80092f3

github-advanced-security bot found potential problems Jul 5, 2024

View reviewed changes

packages/toolkit/scripts/project/build.js Fixed Show fixed Hide fixed

packages/toolkit/scripts/project/create-payload.js Fixed Show fixed Hide fixed

packages/toolkit/scripts/project/init.js Fixed Show fixed Hide fixed

dustinrue added 5 commits July 5, 2024 17:44

attempt to make linter happy

147c729

fix description for create-payload

bbaae33

monorepo instead of modern, common instead of legacy, improve init pr…

a50a15d

…ocess

convenience method for updating the composer lock file

686b4e4

ability to package into a container image, updated readme

83b03a4

dustinrue requested review from tlovett1 and nicholasio August 9, 2024 20:31

github-advanced-security bot found potential problems Aug 9, 2024

View reviewed changes

packages/toolkit/scripts/project/init.js Fixed Show fixed Hide fixed

packages/toolkit/scripts/project/init.js Fixed Show fixed Hide fixed

packages/toolkit/scripts/project/package.js Fixed Show fixed Hide fixed

packages/toolkit/scripts/project/update-composer.js Fixed Show fixed Hide fixed

tlovett1 added 17 commits August 15, 2024 11:45

Remove directory slash detection; properly name templateInitPath vari…

14e3cdc

…able; remove composer block that wasnt doing anything

Merge branch 'feature/add-more-flexibility' into feature/add-more-fle…

da5a17b

…xibility-tl

Change standard layout to wpparent; remove create-payload and support…

71547ff

… a option in the build command that lets you specify

Fix typo

53698e1

Use wpparent

81dc4c4

Remove build_script_path as it's not needed anymore

2741ae7

Remove deploy_script_path

e31e262

Rename build-setup.sh to scripts.sh

ea8fc46

Now we get the git branch in node so we can pass the proper environme…

345a06e

…nt to bash including the proper WORDPRESS_VERSION

Add skip ci option

470ae80

Remove unneeded default variable

fc3f2c9

Remove duplicate composer installs; fix project layout checking logic

4356cdd

Fix variables

f848f27

Doc updates

800b38d

Doc updates

c6700d8

Fix message

47aef83

Only pushd and popd in wpparent layout

99fafc7

Merge pull request #421 from 10up/feature/add-more-flexibility-tl

9a76fed

Feature/add more flexibility tl

github-advanced-security bot found potential problems Aug 20, 2024

View reviewed changes

dustinrue added 2 commits August 20, 2024 12:05

keep consistent with the project on tabs vs spaces

a4499e8

maybe support shells other than bash

61ba982

github-advanced-security bot found potential problems Aug 20, 2024

View reviewed changes

Add changeset

8587947

tlovett1 approved these changes Aug 21, 2024

View reviewed changes

tlovett1 merged commit 8b74e5a into develop Aug 21, 2024
7 checks passed

tlovett1 added a commit that referenced this pull request Aug 21, 2024

Squashed commit of the following:

7692784

commit 8b74e5a Author: Dustin Rue <[email protected]> Date: Wed Aug 21 14:36:32 2024 -0500 Feature/add more flexibility (#413) Co-authored-by: Taylor Lovett <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/add more flexibility #413

Feature/add more flexibility #413

dustinrue commented Jul 5, 2024

changeset-bot bot commented Jul 5, 2024 •

edited

Loading


		setEnvVariables(variables);

		execSync(`bash -l ${__dirname}/bash/scripts.sh package`, {

Feature/add more flexibility #413

Feature/add more flexibility #413

Conversation

dustinrue commented Jul 5, 2024

Description of the Change

Alternate Designs

Possible Drawbacks

Verification Process

Checklist:

changeset-bot bot commented Jul 5, 2024 • edited Loading

🦋 Changeset detected

changeset-bot bot commented Jul 5, 2024 •

edited

Loading