Skip to content

Rename configPath to config #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andrey-helldar merged 1 commit into from
Jan 15, 2026
Merged

Rename configPath to config #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ jobs:
# By default, .github/preview-updater.yml
#
# Required: false
configPath: ''
config: ''
```

The action is setting the following outputs:
Expand All @@ -73,10 +73,10 @@ The action is setting the following outputs:
>
> For example,
>
> - template is `https://github.com/<repo>/.github/blob/main/<configPath>`.
> - template is `https://github.com/<repo>/.github/blob/main/<config>`.
> - result is `https://github.com/TheDragonCode/.github/blob/main/.github/preview-updater.yml`.

Create `.github/preview-updater.yml` (or provide your own path via `configPath`).
Create `.github/preview-updater.yml` (or provide your own path via `config`).
All fields are optional—omitted ones fall back to defaults.

```yaml
Expand Down
2 changes: 1 addition & 1 deletion action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ inputs:
GitHub token with `contents:write` permission used to read and update repository files.
required: true

configPath:
config:
description: Path to the preview configuration YAML file.
default: '.github/preview-updater.yml'
required: false
2 changes: 1 addition & 1 deletion src/utils/inputs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export const TOKEN = {
};

export const CONFIG_PATH = {
name: "configPath",
name: "config",
env: "INPUT_CONFIG_PATH",
defaultValue: ".github/preview-updater.yml",
};
Expand Down