data-structure.md

TOC

• component configuration files
  • version file
  • mdeps file
• environment vars
  • SCM4J_CC: list of yaml files which map artifact coordinates to repositories URLs
  • SCM4J_CREDENTIALS: list of yaml files which defines credentials
• comment tags
• working files

component configuration files

Component configuration files should be located in the root of repository

• version
  • Keeps development and release version numbers
• mdeps
  • Managed dependencies list

version file

Contains a single line.

develop branch:

1.5.0-SNAPSHOT

release branch:

1.4.0

mdeps file

Keeps managable dependencies

develop branch:

com.mycompany:component-one:
com.mycompany:component-two:master-SNAPSHOT
com.mycompany:component-three:

Note: master-SNAPSHOT must be used for components which use jitpack

release branch:

Actual versions in release branch are locked automatically during fork operation

com.mycompany:component-one:4.2.0
com.mycompany:component-two:1.56.0
com.mycompany:component-three:2.1.0

comment tags

Comment tags are placed inside commit comments

• #scm-mdeps
  • Commit in release branch which actualizes mdeps.conf dependencies
• #scm-ver 1.5.0
  • Commit in develop branch which increments version
• #scm-ver release
  • Commit in release branch which truncates -SNAPSHOT
• #scm-ignore
  • Commit in develop branch which shows that all previous feature commits are ignored

working files

Working files are located at ${user.home}/.scm4j

• vcs-repositories: repositories working copies