Development

This describes the development process of the company project (mycompany-orchescala/helper.scala).

Make sure helper.scala is executable:

cd ~/dev-mycompany/mycompany-orchescala
chmod +x helper.scala



To update this project, use cd .. and then ./helperCompany init - see Init Company.

update

./helper.scala update

Updates the company project itself (build files, wrappers, 00-docs scaffolding).

The API page every project ships (03-api/OpenApi.html and 03-api/PostmanOpenApi.html, written by the project's ./helper.scala update and uploaded by its publish) comes with orchescala: the documentation app in 04-orch-doc is built into the orchescala-orch-doc jar, a dependency of the helper - nothing to build or configure in the company. The page loads the yml named like itself.

publish

Creates a new Release for the Company project (company-orchescala) and publishes to the repository(e.g. Artifactory)

Usage:

./helper.scala publish <VERSION>

Example:

./helper.scala publish 0.2.5

The same steps are executed as for the publish command in any project. See project publish.

Company Documentation

This is a semi-automatic process. This should be done either to prepare a Release or after a Release.



At the moment this is based on using Postman and a WebDAV server.

So get in touch if you have a different setup.

Do the following steps:

Open the company-orchescala project in your IDE.
Configure the Release - edit 00-docs/CONFIG.conf.
Copy the actual Production Versions of the Release (00-docs/VERSIONS.conf) to 00-docs/VERSIONS_PREVIOUS.conf from Postman.

Copy the new Versions of the Release to 00-docs/VERSIONS.conf from Postman.

// START VERSIONS
// Workers
companyAccountingWorkerVersion = "1.8.11" 
...
// Project
companyAccountingVersion = "0.8.11" 
...

// END VERSIONS

See Deploy the Projects

prepareDocs

Prepare the company documentation.

./helper.scala prepareDocs



Be aware that this overwrites release.md

prepareDocs ends with a local preview of the documentation site: the site is assembled into 00-docs/site (this company and its siblings, the project APIs at their released versions, orch-spec with its catalog) and served - the URL is printed (Preview ready: http://localhost:3004/) and the command keeps running until you stop it with Ctrl-C. A failure in the spec catalog or the sibling repos does not stop the preview, it is printed and the preview continues with what is available. Everything needed ships with orchescala; Node.js is only used for the orch-spec catalog (skipped without it).

Manually adjust the Release Notes release.md - and check the result in the local preview (run prepareDocs again, or npm run site in orch-doc).

publishDocs

Release the company documentation.

./helper.scala publishDocs

Builds the documentation site (this company and its siblings, the project APIs at their released versions, orch-spec) into 00-docs/site and uploads it to /site on the WebDAV server. /site is never deleted as a whole: the projects' own folders (/site/<company>/<project>/, published by each project) and the classic sites of older releases (/site/<company>/<tag>/) stay - only assets/ and spec/ are replaced. Needs Java and git only - Node.js just for the orch-spec catalog.

Check the result on your Company Documentation Page (<documentationUrl>/site/#/<company>).