Skip to content

A bootstrap project for creating new glasir.pkg package management packages

License

Notifications You must be signed in to change notification settings

iteego/glasir.pkg.base

Repository files navigation

Description

This project is a base 'bootstrap' project for creating new glasir.pkg package management packages.

glasir is a family of tools to improve productivity in Oracle ATG e-commerce products.

glasir.pkg is part of the glasir product family and makes it possible to perform automated on-the-fly installations of required products such as the Oracle ATG E-commerce platform, the JBoss application server, and various ATG products required to run an e-commerce application.

This project is a 'bootstrap' project which can be used as a starting point when creating new auto-install glasir.pkg packages.

Note, the instructions below assume that you want to version control the files used to create the glasir.pkg package and that you use git to do so. Both of these choices are optional, you can use another source control system and/or choose not to version control you package creation.

To Create a New glasir.pkg Package

To create a glasir.pkg package for a new ATG artifact using this project (and git):

  • clone this repository
  • delete the .git directory from the cloned repository
  • you probably want to remove or modify the README.md file (this text)
  • rename the cloned directory 'glasir.pkg.base' to correspond to the artifact you want to create a glasir.pkg for. Example: for ATG10.0.3 rename the directory to 'glasir.pkg.atg-10.0.3', for jboss-eap-5.1.0 rename the directory to 'glasir.pkg.jboss-eap-5.1.0'
  • unzip your ATG artifact (such as the ATG platform installation, CommerceReferenceStore, Search, JBoss etc) directly into the root of the cloned repository. Example: <scm_root>/ATG10.0.2/
  • if you want to trim your git repository, see if you can live without some of the content in your artifact directory. An example would be the 'patch' directory found in most ATG installations. This directory is only needed when installing ATG products, is not used runtime, and usually takes up a lot of space. Since product installation in glasir is handled by the glasir.pkg system, the patch directory is unnecessary. Another example would be the jboss servers directory which contains a number of servers commonly not used in glasir (normally only the 'default' server definition is used).
  • edit gradle.properties file to correspond to your ATG product and version. Example for ATG10.0.3: pkgProduct=ATG pkgVersion=10.0.3 Example for jboss-eap-5.1.0: pkgProduct=JBoss pkgVersion=5.1.0
  • execute 'gradlew clean jar' to build a glasir.pkg package at build/libs.
  • to deploy the package to a maven/artifactory/nexus server, please use ci-server artifactory/nexus/etc integrations (recommended) or look to the gradle documentation for how to publish artifacts directly by modifying this build script.
  • Optional, re-create a git repo to track future changes to this package: Execute (from the root of the git repository):
     
    git init .
    git add .gitignore
    git add .gradle/.gitignore
    git add .
    git commit -a -m "your commit message"
    
  • Optional, push the git repo to your github account and/or to a custom git server.
  • Optional, set up a ci job to auto-deploy the generated artifact when changes are committed to this repo.

once you have deployed the glasir.pkg package to your maven/artifactory/nexus server, you can use the deployed package in a glasir-enabled e-commerce project by inserting code like the following into the settings.gradle file in the root of your project structure:

new glasir.Build(this).with {
  setup {
    dependencies {
      glasirpackage("com.iteego.glasir.pkg:atg-10.0.2:1.0.0")
    }

    addAtgModules from: atgRoot
  }
}

License

Glasir.pkg is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Glasir.pkg is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Foobar. If not, see http://www.gnu.org/licenses/.

About

A bootstrap project for creating new glasir.pkg package management packages

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages