Skip to content

Installation.md

Latest commit

 

History

History
47 lines (37 loc) · 1.29 KB

Installation.md

File metadata and controls

47 lines (37 loc) · 1.29 KB

Installation

Basic Installation

You can load okr-api evaluating:

Metacello new
	baseline: 'OKRAPI';
	repository: 'github://Mercap/okr-api:release-candidate/source';
	load.

Change release-candidate to some released version if you want a pinned version

Using as dependency

In order to include okr-api as part of your project, you should reference the package in your product baseline:

setUpDependencies: spec

	spec
		baseline: 'OKRAPI'
			with: [ spec
				repository: 'github://Mercap/okr-api:v{XX}/source';
				loads: #('Deployment') ];
		import: 'okrapi'.

Replace {XX} with the version you want to depend on

baseline: spec

	<baseline>
	spec
		for: #common
		do: [ self setUpDependencies: spec.
			spec package: 'My-Package' with: [ spec requires: #('OKRAPI') ] ]

Provided groups

  • Deployment will load all the packages needed in a deployed application
  • Tests will load the test cases
  • Dependent-SUnit-Extensions will load the extensions to the SUnit framework
  • Tools will load the extensions to the SUnit framework and development tools (inspector and spotter extensions)
  • CI is the group loaded in the continuous integration setup
  • Development will load all the needed packages to develop and contribute to the project