Skip to content

make_workflows.md

Latest commit

 

History

History
148 lines (110 loc) · 5.37 KB

make_workflows.md

File metadata and controls

148 lines (110 loc) · 5.37 KB
Raw

Make Workflows

Overview

Custy's root Makefile loads focused modules under make/core/. Run Make from the Custy repository root and use the project help to discover targets:

make help
make help-remote

Bare make and make help display the project's formatted command list. make --help displays GNU Make's own executable help and is not controlled by this repository.

Published Reflow Image

The r-reflow-* targets run the published Reflow image from GHCR against the workspace selected by REMOTE_WORKSPACE. Registry management is separate from runtime execution:

make r-reflow-info
make r-reflow-pull
make r-reflow-remove

r-reflow-push publishes a container image and therefore requires explicit registry credentials and intent.

The runtime targets follow Reflow's current CLI command names:

Reflow CLI workflow Custy Make target Preview target
reflow init r-reflow-init r-reflow-init-dryrun
reflow releases recover r-reflow-releases-recover r-reflow-releases-recover-dryrun
reflow tags convert r-reflow-tags-convert r-reflow-tags-convert-dryrun
reflow dockerize r-reflow-dockerize r-reflow-dockerize-dryrun

The r-reflow-tags-replay targets are deprecated compatibility aliases. They display a warning and delegate to r-reflow-releases-recover; they do not call the deprecated CLI spelling directly.

Repository Targets

For a local repository, mount the target as the remote workspace:

make r-reflow-tags-convert-dryrun \
  REMOTE_WORKSPACE="D:/project/testing_lab/testing_reflow"

The mounted directory becomes /workspace inside the container, so Reflow uses it as the current repository unless another target is supplied.

For a GitHub or GitLab URL, pass the global Reflow option before the command:

make r-reflow-tags-convert-dryrun \
  REMOTE_REFLOW_GLOBAL_ARGS="--repository-url https://github.com/owner/repository.git"

For a live remote conversion, add --push --yes to the command-specific arguments. Without --push, tags created in a temporary URL checkout disappear when Reflow removes that checkout.

make r-reflow-tags-convert \
  REMOTE_REFLOW_GLOBAL_ARGS="--repository-url https://github.com/owner/repository.git" \
  REMOTE_REFLOW_TAGS_CONVERT_ARGS="--to semver --push --yes"

reflow init requires a local repository target and does not accept a repository URL.

Arguments

Use the variable matching the command layer:

Variable Purpose
REMOTE_REFLOW_GLOBAL_ARGS Global options such as --repository, --repository-url, --debug, or --no-banner
REMOTE_REFLOW_INIT_ARGS Options passed to reflow init
REMOTE_REFLOW_RELEASES_RECOVER_ARGS Options passed to reflow releases recover
REMOTE_REFLOW_TAGS_CONVERT_ARGS Options passed to reflow tags convert
REMOTE_REFLOW_DOCKERIZE_ARGS Options passed to reflow dockerize
REMOTE_REFLOW_EXTRA_ARGS Final escape hatch for additional command arguments

Dry-run targets append the global --dry-run option. They preserve repository selection and every other value already supplied through REMOTE_REFLOW_GLOBAL_ARGS.

Dockerize Access

Reflow's dockerize workflow invokes Docker from inside the Reflow container. The Make target mounts DOCKER_SOCKET, which defaults to /var/run/docker.sock, so the container can communicate with the host Docker daemon.

make r-reflow-dockerize-dryrun \
  REMOTE_WORKSPACE="D:/project/testing_lab/testing_reflow"

Override DOCKER_SOCKET only when the host uses a different Docker endpoint.

Remote Custy Credential Helpers

Published Custy-image workflows can use an external credential directory without copying tokens into the repository or image:

make r-custy-credentials-set-github
make r-custy-credentials-set-gitlab
make r-custy-credentials-status
make r-custy-credentials-test CUSTY_CREDENTIALS_REMOTE=origin

The two set targets mount the credential directory read-write so Custy can store the selected provider token. status and test mount it read-only; test performs a read-only access check against the selected Git remote. Credential values are not passed as Make variables or printed by these targets.

CUSTY_CREDENTIALS_HOST_DIR defaults to %LOCALAPPDATA%/Custy/credentials on Windows and $XDG_DATA_HOME/custy/credentials or $HOME/.local/share/custy/credentials on Unix. The directory is mounted at CUSTY_CREDENTIALS_CONTAINER_DIR, which defaults to /run/secrets/custy.

Normal r-custy-run* and r-custy-workflow execution does not mount this directory by default. Enable its read-only runtime mount explicitly when the selected workflow needs the configured fallback:

make r-custy-run-push CUSTY_CREDENTIALS_MOUNT=true

Safety and Credentials

Start with a -dryrun target. Reflow previews its own Git, release, and Docker mutations, but registry management targets such as r-reflow-push and r-reflow-remove are direct Docker operations and do not have Reflow dry-run semantics.

Remote Git pushes, release recovery, and registry publication require the corresponding credentials inside the container. Do not store tokens in the Makefile or container image; provide credentials securely at runtime.