flarc

flarc is a libphutil library that contains various Arcanist extensions used at Freelancer.com, mostly relating to linting and testing integrations.

Installation

To use flarc, you must clone the repository into a location that Arcanist knows how to load it. Arcanist adjusts the PHP include path in arcanist_adjust_php_include_path so that libphutil libraries can be loaded from any of the following locations:

1. A directory adjacent to arcanist/ itself.
2. Anywhere in the normal PHP include_path.
3. Inside arcanist/externals/includes/.

Usage

general usage

To use flarc in your project, add flarc/src to the load path in the project's .arcconfig:

{
  "load": ["flarc/src"]
}

Usage in fl-gaf

To pin the version of flarc used in fl-gaf, update the FLARC_VERSION in rGaf/support/flarc/src/common/FlarcVersionChecker.php.

Usage in CI

flarc is built and used as a docker image in CI.

To build flarc docker image run this CI job manually. Otherwise, it will be built daily.

php build base docker image depends on flarc docker image. Trigger this CI job manually after 1st job finishes. Otherwise, it will be built weekly.

Development

Adding/Updating Linters

For more information on adding or updating linters, see lint/README.md.

Versioning

To create a new version of flarc:

• Update composer.json to the new version.
• Run arc liberate and composer update --lock.