CircleCI-Public / CircleCI-Public/path-filtering-orb

Why is the `config-path` default named `continue_config.yml`? Proposal for a more explicit name

Open
#137 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Shell
Stars
29
Forks
70
PR merge metrics
No merged PRs in 30d

Description

## Context

The `config-path` parameter (used in the `filter` and `set-parameters` commands) defaults to `.circleci/continue_config.yml`.

```yaml
config-path:
type: string
default: ".circleci/continue_config.yml"
description: >
The location of the config to continue the pipeline with...
```

## Question

Is there a specific reason for the `continue_config` naming? My assumption is that it mirrors the naming used in CircleCI's own dynamic configuration documentation examples, where `continue_config.yml` is the canonical example filename. If that's the case, it makes sense internally — but for users discovering the orb without prior knowledge of the continuation mechanism, the name is not immediately intuitive.

## Proposal

If there is no strong technical or historical reason to keep `continue_config.yml` as the default, would you consider renaming it to something more self-descriptive — for example:

- `continuation_config.yml` — spells out the full word instead of abbreviating to `continue`
- `pipeline_config.yml` — describes what the file actually contains (the main pipeline workflows)

Alternatively, if the name is intentionally aligned with CircleCI's official docs, a short note in the parameter description explaining that rationale would already help a lot.

Happy to open a PR if a rename is agreed upon.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the config-path parameter definitions used by the filter and set-parameters commands and review the current default and description shown in the issue. Before changing anything, confirm whether the project wants a renamed default or only an explanatory note; done requires an agreed naming decision and corresponding documentation or parameter update.

Written by the indexing model from the issue text.

Assessment

Tech stack
yaml
Domain
ci-cd
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.