Files
git.taskfile.build/CHANGELOG.md
T
Janik von Rotz 5b992d4ee0 docs(agents): refine bash guidelines and update code samples
- Expand AGENTS.md with general agent guidance and coding conventions
- Refactor bash snippets in README.md and scripts to align with style guide:
  - Use `#!/usr/bin/env bash` shebang for portability
  - Remove `function` keyword from definitions
  - Replace `[ ]` conditionals with `[[ ]]` for improved reliability
  - Rename local variables to lowercase with `local` keyword
- Introduce CHANGELOG.md to track project changes per Keep a Changelog spec
- Update taskfile.build scripts to follow consistent bash practices
2025-10-29 12:32:51 +01:00

2.4 KiB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog.

[Unreleased]

Added

  • New CHANGELOG.md file to document project changes following Keep a Changelog specifications

Changed

  • Updated task script to follow AGENTS.md bash guidelines:
    • Changed shebang from #!/bin/bash to #!/usr/bin/env bash for portability
    • Removed function keyword from all function definitions, using func-name() { syntax
    • Updated all conditional tests from [ ] to [[ ]] for better functionality
    • Converted local variables in help-table() function to lowercase with local keyword:
      • CMD_WIDTH → local cmd_width
      • OPT_WIDTH → local opt_width
      • DESC_WIDTH → local desc_width
      • COLUMN → local column
    • Updated printf statements to use new lowercase variable names
  • Updated image/entrypoint.sh script to follow AGENTS.md bash guidelines:
    • Changed shebang from #!/bin/bash to #!/usr/bin/env bash for portability
    • Updated all conditional tests from [ ] to [[ ]]:
      • if [[ -z "$GIT_URL" ]]
      • if [[ ! -d "$GIT_PATH" ]]
      • if [[ -f "$GIT_PATH/.gitmodules" ]]
      • if [[ -f "${GIT_PATH}/task" ]]
      • if [[ -z "$TASK_COMMANDS" ]]
  • Updated bash code snippets in README.md to follow AGENTS.md bash guidelines:
    • Updated shebangs to use #!/usr/bin/env bash
    • Removed function keyword from all function definitions
    • Updated conditional tests from [ ] to [[ ]]
    • Updated arithmetic comparisons to use (( )) syntax where appropriate
    • Updated local variables within functions to use lowercase names with local keyword:
      • DATABASE → local database in drop-db() function
      • FOLDER → local folder in render() function
      • Variables in convert-vault-file() function:
      • Variables in process-data() function:
    • Updated deploy() function to use [[ -z "$1" ]] instead of test -z "$1"
  • Further updated bash code snippets in README.md to ensure full compliance with AGENTS.md guidelines:
    • Updated remaining [ -n "$1" ] conditions to use [[ -n "$1" ]] syntax
    • Updated remaining test -z "$1" conditions to use [[ -z "$1" ]] syntax
    • Ensured all local variables follow lowercase naming convention
    • Verified all conditional expressions use [[ ]] instead of [ ] or test