adobe / aem-site-template-builder Goto Github PK

View Code? Open in Web Editor NEW

23.0 11.0 6.0 271 KB

License: MIT License

JavaScript 100.00%

aem-site-template-builder's Introduction

AEM Site Template Builder

This repository contains scripts for building AEM Site Templates.

Installation

Required dependencies: node, npm, mvn

cd your-aem-site-template
npm install @adobe/aem-site-template-builder --save-dev

Usage

To build your AEM Site Template just go into its folder and run command:

npx aem-site-template-builder

Expected structure of the repository

files/                  Optional, folder with the UI kit XD file and possibly other files.
    design.xd
previews/               Folder with screenshots of the site template.
    buttons.png
    navigation.png
    teaser.png
site/                   Content module that contains the templates and policies.
theme/                  Optional, theme sources (CSS, JS). It's a npm package with dev-dependency to aem-site-theme-builder.
package.json            Includes meta informations.
    - version           The version of the Site Template.
    - name              Unique name to help AEM to only contain a Site Template once.
    - title             Name of Site Template displayed in AEM UI.
    - description       Free-formed text that can contain some HTML like paragraphs, lists, links.
    - createdBy         Author or vendor.
    - useCases          List of strings that describe the purpose of the site template.
    - docsUrl
    - showcaseUrl
    - sourceRepositoryUrl
    - license

NPM scripts in your template

Template Builder assumes that your AEM Site Template will contain npm run build npm script in the /theme folder which will compile the theme sources into production ready compiled code available in /theme/dist folder.

Compiled site template artifact

files/                  Optional, folder with the UI kit XD file and possibly other files.
    design.xd
previews/               Folder with screenshots of the site template.
    buttons.png
    navigation.png
    teaser.png
site.zip                Content package that contains the templates and policies.
theme.zip               Optional, contains compiled theme.
theme-sources.zip       Optional, zipped theme sources folder.

Local development

For development purposes you can build local npm package which will provide aem-site-template-builder command. You need access to AEM Site Template Builder repository.

Clone AEM Site Template Builder repository.
cd aem-site-template-builder
npm link

Now you should have aem-site-template-builder command available globally as a command line. All changes that you will provide for the aem-site-template-builder script sources will get automatically applied to the linked command.

Release and publish

Run the "Release and publish" GitHub workflow and provide the semantic version you're about to release.

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

Licensing

This project is licensed under the MIT License. See LICENSE for more information.

aem-site-template-builder's People

Contributors

Stargazers

Watchers

Forkers

isabella232 desinghdel adobe-system lribeirodev ghas-results francostino

aem-site-template-builder's Issues

Clarify supported Node, NPM and Maven versions

Currently the readme only states:

Required dependencies: node, npm, mvn

Please give a hint on the supported versions (minimum and also maximum if applicable).

Site template builder relies on Site Template being a git repo

Problem is in the way that template-builder builds the aem-site-template-basic-x.x.x.zip file. It relies on the fact that Site Template should be a git repository so it can create theme-sources folder by filtering only necessary files from the theme folder based on its .gitignore. To do that it has to be a proper git project (with .git folder).

Expected Behaviour

theme-sources.zip file is part of aem-site-template-basic-4.0.1.zip file created by running npx aem-site-template-builder therefore theme sources can be downloaded from AEM.

Actual Behaviour

theme-sources.zip file is missing in aem-site-template-basic-4.0.1.zip file created by running npx aem-site-template-builder therefore theme sources can not be downloaded from AEM.

Reproduce Steps

Download a source-code from Site Template Basic 4.0.1.
Unzip aem-site-template-basic-4.0.1.zip.
Go to folder aem-site-template-basic-4.0.1.
Run npx aem-site-template-builder.
Go to AEM and upload your newly created aem-site-template-basic-4.0.1.zip. (make sure to not upload source code but generated package)
Try to download theme sources.

Further Explanation

aem-site-template-basic-x.x.x.zip file created by running Reproduce Steps does not contain theme-sources.zip file in the package. Due to that you can’t download theme sources in AEM.

Proposed Solution

Use graceful degradation approach and in case Site Template is not a git repository include all of theme content into theme-sources.zip file.
Create theme-sources.zip before compiling and building theme so it is less polluted.

Workarounds

For now there are 2 workarounds:

Download Site Template sources by cloning the github repository.
Download Site Template in the way you do know (as source-code from specific release). After downloading go inside and create git project by git init .

Expected Behaviour

Up to date dependencies don't cause audit issues which can break CI/CD builds.

Actual Behaviour

npm audit fails:

engine.io  <4.0.0
Severity: high
Resource exhaustion in engine.io  - https://github.com/advisories/GHSA-j4f2-536g-r55m
No fix available
node_modules/engine.io
  socket.io  1.0.0-pre - 2.4.1
  Depends on vulnerable versions of engine.io
  node_modules/socket.io
    browser-sync  >=1.0.0
    Depends on vulnerable versions of socket.io
    node_modules/browser-sync
      @adobe/aem-site-theme-builder  *
      Depends on vulnerable versions of browser-sync
      Depends on vulnerable versions of shelljs
      node_modules/@adobe/aem-site-theme-builder

shelljs  <0.8.5
Severity: high
Improper Privilege Management in shelljs - https://github.com/advisories/GHSA-4rq4-32rv-6wp6
No fix available
node_modules/shelljs
  @adobe/aem-site-theme-builder  *
  Depends on vulnerable versions of browser-sync
  Depends on vulnerable versions of shelljs
  node_modules/@adobe/aem-site-theme-builder

Reproduce Scenario (including but not limited to)

Run npm audit from theme folder

adobe / aem-site-template-builder Goto Github PK

aem-site-template-builder's Introduction

AEM Site Template Builder

Installation

Usage

Expected structure of the repository

NPM scripts in your template

Compiled site template artifact

Local development

Release and publish

Contributing

Licensing

aem-site-template-builder's People

Contributors

Stargazers

Watchers

Forkers

aem-site-template-builder's Issues

Expected Behaviour

Actual Behaviour

Reproduce Steps

Further Explanation

Proposed Solution

Workarounds

Expected Behaviour

Actual Behaviour

Reproduce Scenario (including but not limited to)

Steps to Reproduce

Platform and Version

Sample Code that illustrates the problem

Logs taken while reproducing problem

Recommend Projects

Recommend Topics

Recommend Org