Skip to content
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

chore: File renaming for consistency and clarity: #6

Merged
merged 1 commit into from
Oct 23, 2024
Merged

chore: File renaming for consistency and clarity: #6

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
0 .github/ISSUE_TEMPLATE/bug-report.yml → .github/ISSUE_TEMPLATE/bug-report.yaml
View file
Open in desktop
File renamed without changes.
0 .github/ISSUE_TEMPLATE/config.yml → .github/ISSUE_TEMPLATE/config.yaml
View file
Open in desktop
File renamed without changes.
0 .github/ISSUE_TEMPLATE/feature-request.yml → .github/ISSUE_TEMPLATE/feature-request.yaml
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion .github/workflows/pr-title.yaml → .github/workflows/pr-title-checks.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: "pr-title"
name: "pr-title-checks"

on:
pull_request_target:
Expand Down
2 changes: 1 addition & 1 deletion lint-tasks.yml → lint-tasks.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ tasks:
CHECKSUM_FILE: "{{.G_BUILD_DIR}}/{{.TASK | replace \":\" \"#\"}}.md5"
OUTPUT_DIR: "{{.G_LINT_VENV_DIR}}"
sources:
- "{{.ROOT_DIR}}/Taskfile.yml"
- "{{.ROOT_DIR}}/taskfile.yaml"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Additional YAML extension inconsistencies found

There are still inconsistent .yml extensions in the codebase that should be standardized:

  • tools/yscope-dev-utils/taskfiles/utils.yml is included in taskfile.yaml
  • tools/yscope-dev-utils/lint-configs/.yamllint.yml is referenced in .yamllint.yaml

These files appear to be in a tools directory, but for complete consistency, these references should also be updated to use the .yaml extension.

🔗 Analysis chain

LGTM! Let's verify consistency across the codebase.

The file reference update aligns with the standardization objectives for YAML file extensions and naming conventions.

Let's verify the consistency of these changes across the codebase:

Let me check the content of these files to better understand the remaining .yml references and verify if they need attention.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify consistent usage of taskfile.yaml and .yaml extensions

# Test 1: Check for any remaining .yml references
echo "Checking for remaining .yml references..."
rg -l '\.yml' --type yaml

# Test 2: Check for any remaining references to the old Taskfile.yml
echo "Checking for references to old Taskfile.yml..."
rg -l 'Taskfile\.yml'

# Test 3: Verify consistent casing of taskfile.yaml
echo "Checking for inconsistent casing of taskfile.yaml..."
rg -l -i 'taskfile\.ya?ml'

Length of output: 436

Script:

#!/bin/bash
# Check content of taskfile.yaml for .yml references
echo "=== Content of taskfile.yaml ==="
cat taskfile.yaml

# Check content of .yamllint.yaml
echo -e "\n=== Content of .yamllint.yaml ==="
cat .yamllint.yaml

Length of output: 619

- "{{.TASKFILE}}"
- "lint-requirements.txt"
generates: ["{{.CHECKSUM_FILE}}"]
Expand Down
2 changes: 1 addition & 1 deletion Taskfile.yml → taskfile.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: "3"

includes:
lint: "lint-tasks.yml"
lint: "lint-tasks.yaml"
utils: "tools/yscope-dev-utils/taskfiles/utils.yml"

vars:
Expand Down