Skip to content

Latest commit

 

History

History
155 lines (102 loc) · 4.28 KB

build.md

File metadata and controls

155 lines (102 loc) · 4.28 KB

Building TCR on your machine

This section provides information related to TCR tool development environment setup for those who would like to build TCR tool locally.

Clone TCR repository - Required

git clone https://github.com/murex/TCR.git
cd TCR

Install Go SDK - Required

TCR is written in Go. This implies having Go compiler and tools installed on your machine.

Simply follow the instructions provided here. Make sure to install Go version 1.24 or higher.

Install additional Go tools and utility packages

Go IDE - Optional

You can check this link for a list of recommended IDEs supporting Go language.

Cobra library and tools - Optional

TCR Go command line options and parameters are managed using Cobra.

The Cobra library download is already dealt with through Go Module dependencies, which means that in most situations you will not need to worry about installing it.

In case you need to add or modify subcommands, options or parameters, you may want to use the Cobra Generator. In this situation you can refer to Cobra Generator documentation

GoReleaser utility - Optional

New versions of TCR Go are released through GoReleaser.

You should not need it as long as you don't plan to release a new TCR Go version.

If you do, you can refer to GoReleaser Installation Instructions for installing it locally on your machine.

In most cases you will not even have to install it locally as TCR-Go new releases are built through a GoReleaser GitHub action.

golangci-lint package - Optional

We use the Go Linter aggregator golangci-lint to perform various static checks on TCR Go code.

A dedicated GitHub action triggers execution of golangci-lint every time a new TCR-Go version is being released.

Although not mandatory, we advise you to install it locally on your machine to check that your changes comply with golangci-lint rules. Refer to golangci-lint installation instructions for installation.

Once golangci-lint is installed, you can run it from the root directory:

make lint

Both local run and GitHub Action use this configuration file

gotestsum utility - Optional

We use gotestsum for running tests with the possibility to generate a xunit-compatible test report.

Although not mandatory, we advise you to install it locally on your machine as it greatly improves readability of test results. Refer to gotestsum's Install section for installation.

Once gotestsum is installed, you can run make's test target from the root directory:

  • For running all tests:

    make test

  • For running short tests only:

    make test-short

  • For listing slowest tests (default threshold: 500ms):

    make slow-tests

Build TCR executable

To build TCR locally on your machine, simply type the following from the root directory:

make

This command generates the TCR (in src directory) executable, as well as the command help pages ( in doc directory).

To build TCR only

Either run the following command from the root directory:

make -C ./src

Or run make from src directory:

cd src
make

To generate TCR command markdown documentation

make doc

Testing local TCR manually

The tools/tcr/tcr-local.sh script runs the latest TCR built from local sources on the src/testdata/java sample. The src/tcr-local script is just a convenience wrapper for this.

To launch it:

cd src
./tcr-local

You can alternatively use the following make target from either the repository root directory or src directory:

make run

If you want to test with the Perforce client:

cd src
./tcr-local-p4