Targets

Targets are used to define the desired hallux output. Suggestions that come from the proposal engine can be written into local files, individual commits, or Github/Gitlab pull requests as suggestions.

--files (default)

Writes fixes directly into local files.

--git

Adds a separate git commit for every successful fix. The project must be in a GIT repository with no uncommitted changes to enable this target.

--github

Submits issue fixes as suggestions into Github pull requests. The project must be in a GIT repository with no uncommitted changes. The head SHA in local git and on Github must be the same.

hallux --github="https://BUSINESS.github.com/ORG_NAME/REPO_NAME/pull/ID" .

Accepts as the value of the --github flag a Github pull request URL.

GITHUB_TOKEN environment variable must be provided.

--gitlab

Submits issue fixes as suggestions into Gitlab merge requests. The project must be in a GIT repository with no uncommitted changes. The head SHA in local git and on Gitlab must be the same.

Accepts as the value of the --gitlab flag a Gitlab merge request URL or gitlab API URL.

# Merge request URL:
hallux --gitlab="https://gitlab.com/GROUP_NAME/REPO_NAME/-/merge_requests/$CI_MERGE_REQUEST_ID" .
 
# Gitlab API URL:
hallux --gitlab="https://SUBDOMAIN.BUSINESS.com/ROUTE/api/GROUP_NAME/REPO_NAME/-/merge_requests/$CI_MERGE_REQUEST_ID" .

Notes:

GITLAB_TOKEN environment variable must be provided.
$CI_MERGE_REQUEST_ID is a Gitlab CI/CD environment variable that contains the merge request ID.

Backends