Development
This describes the development process of the company project (mycompany-camundala/helper.scala
).
Make sure helper.scala
is executable:
cd ~/dev-mycompany/mycompany-camundala
chmod +x helper.scala
To update this project, use cd ..
and then ./helperCompany init
- see Init Company.
publish
Creates a new Release for the Company project (company-camundala
) 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-camundala
project in your IDE. - Configure the Release - edit
00-docs/CONFIG.conf
. - Copy the actual Production Versions of the Release (
00-docs/VERSIONS.conf
) to00-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
prepareDocs
Prepare the company documentation.
./helper.scala prepareDocs
Be aware that this overwrites release.md
-
Manually adjust the Release Notes release.md.
- You can check the result, using the Sbt command laikaPreview on localhost
- If you change the Versions you need to reload SBT.
publishDocs
Release the company documentation.
./helper.scala publishDocs
- Check the result on your Company Documentation Page.