Skip to content

[core] [cli] [nextjs] [create-sitecore-jss] Build time automation #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
yavorsk merged 49 commits into from
Mar 10, 2025
Merged

[core] [cli] [nextjs] [create-sitecore-jss] Build time automation #28

yavorsk merged 49 commits into from
Mar 10, 2025

Conversation

@yavorsk
Copy link
Contributor

@yavorsk yavorsk commented Mar 6, 2025 •
edited
Loading

Description / Motivation

Update the build time automation approach for the jss application:

  • cli renamed to 'scs'
  • introduced 'scs build' and 'scs scaffold' cli commands
  • introduce sitecore.cli.config.ts:
    • the sitecore.cli.config exposes a defineCliConfig function that populates the required configurations
    • configures the functions that are going to be executed during build time by the cli
      • generateMetadata
      • generateSies
    • configures the scaffold component command
      • users can provide their own custom templates for scaffolding components
      • default templates (default and byoc components) are provided on the framework specific package level
  • the build time artifacts are placed under '.sitecore' folder at the root of the app
  • updated the starter app
    • packages scripts
    • references to sites.json

Testing Details

  • Unit Test Added
  • Manual Test/Other (Please elaborate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

yavorsk added 22 commits March 3, 2025 17:39
@yavorsk
rework build automation - wip
e410060
@yavorsk
rework cli config as define sitecore cli config, rework scaffold comp…
d87601f 
…onent and other commands
@yavorsk
clean up and refactor; generateSites now generates sites.json
a871499
@yavorsk
scaffold command with positional parameter
81fd90c
@yavorsk
revert to local and global cli
389ca57
@yavorsk
some cli config model updates
a5afb1f
@yavorsk
unit tests cli package
88333a9
@yavorsk
unit tests core package
b898bc2
@yavorsk
scaffold component tests, some fixes
2af93f9
@yavorsk
generateMetadata tests
88d548e
@yavorsk
define cli config tests
b03a912
@yavorsk
some fixes
4897dcf
@yavorsk
typo fixes
5b64f25
@yavorsk
fixes
4e3f064
@yavorsk
fix unit tests
283533d
@yavorsk
fix import
22563c1
@yavorsk
Merge branch 'dev' into feature/JSS-4735
f74e8c3
@yavorsk
post merge fix
b8f6bfb
@yavorsk
improve error handling during loading of cli config
fb83865
@yavorsk
fix type
49e80d1
@yavorsk
move ensurePath out of utils
1babf74
@yavorsk
update starter app scripts
243bdfa
@yavorsk yavorsk changed the title Feature/jss 4735 [core] [cli] [nextjs] [create-sitecore-jss] Build time automation Mar 6, 2025
@yavorsk yavorsk requested a review from illiakovalenko March 6, 2025 12:54
illiakovalenko
illiakovalenko requested changes Mar 7, 2025
View reviewed changes
stasmaxymov
stasmaxymov reviewed Mar 7, 2025
View reviewed changes
yavorsk and others added 3 commits March 10, 2025 09:48
@yavorsk @illiakovalenko
Update packages/cli/src/bin/scs.ts
9b8152b 
Co-authored-by: Illia Kovalenko <23364749+illiakovalenko@users.noreply.github.com>
@yavorsk @illiakovalenko
Update packages/cli/src/scripts/build.ts
f9b7dca 
Co-authored-by: Illia Kovalenko <23364749+illiakovalenko@users.noreply.github.com>
@yavorsk
clarify warning message for global mode in Sitecore Content SDK CLI
60f36c3
yavorsk and others added 21 commits March 10, 2025 09:53
@yavorsk
Merge branch 'feature/JSS-4735' of https://github.com/Sitecore/xmc-js…
6998bdc 
…s-dev into feature/JSS-4735
@yavorsk @illiakovalenko
Update command description packages/cli/src/scripts/scaffold.ts
a232249 
Co-authored-by: Illia Kovalenko <23364749+illiakovalenko@users.noreply.github.com>
@yavorsk
scaffold command: move template selection logic to cli, updated unit …
2775227 
…tests
@yavorsk
Merge branch 'feature/JSS-4735' of https://github.com/Sitecore/xmc-js…
51189dc 
…s-dev into feature/JSS-4735
@yavorsk
fix lint issue
a8d5178
@yavorsk
update load config tsdoc description
5bd9bf2
@yavorsk
fallback to loading sitecore.clio.config.js if .ts file is missing
1810ecc
@yavorsk
refactor: update CLI config documentation and streamline imports in N…
1479bab 
…ext.js templates
@yavorsk
add tools submodule to generate-docs
800834e
@yavorsk
move nextjs component temnplates to tools submodule
3c3812e
@yavorsk
add tools submodule to generate-docs
b65894e
@yavorsk
refactor: move component templates to tools submodule and update ts docs
217f3ae
@yavorsk
fix: await build commands in CLI to ensure proper execution order
3647ba6
@yavorsk
fix tsdocs to mention the new .sitecore directory
bb976de
@yavorsk
introduce ComponentTemplateType enum; some comment updates
272d223
@yavorsk
modify scaffold to not force src/components for scaffolding component…
360c3f1 
…s; add unit tests to component templates
@yavorsk
generate sites unit tests
bc8c58e
@yavorsk
update yarn lock
b455c8e
@yavorsk
strongly typped scaffold command args
8616ee8
@yavorsk
fix cli config in template
42903c6
@yavorsk
execute build commands synchronously
93212d6
illiakovalenko
illiakovalenko approved these changes Mar 10, 2025
View reviewed changes
Copy link
Collaborator

@illiakovalenko illiakovalenko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Good job!
Few last minor things and then feel free to merge! 👍

yavorsk and others added 2 commits March 10, 2025 16:39
@yavorsk @illiakovalenko
Update type in ts doc in load-config.ts
cf87d56 
Co-authored-by: Illia Kovalenko <23364749+illiakovalenko@users.noreply.github.com>
@yavorsk @illiakovalenko
Update ts doc in load-config.ts
cb5c123 
Co-authored-by: Illia Kovalenko <23364749+illiakovalenko@users.noreply.github.com>
@yavorsk yavorsk merged commit b61df9e into dev Mar 10, 2025
1 check passed
@yavorsk yavorsk deleted the feature/JSS-4735 branch March 10, 2025 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@stasmaxymov stasmaxymov stasmaxymov left review comments

@illiakovalenko illiakovalenko illiakovalenko approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@yavorsk @stasmaxymov @illiakovalenko