Skip to content

Conversation

@ndizazzo
Copy link
Owner

This pull request updates the ACTIONS.md documentation to include more detailed descriptions and examples for built-in actions, introduces new actions, and enhances the README.md to reflect these changes. The most notable updates include the addition of new actions, improved categorization, and practical example tasks for workflows.

Documentation Enhancements in ACTIONS.md:

New Actions Added:

  • ReadFileAction: Reads file contents with error handling and content processing.
  • CompressFileAction: Compresses files using gzip with auto-detection and efficiency features.
  • DecompressFileAction: Decompresses files with auto-detection from file extensions.
  • UpdatePackagesAction: Installs packages using platform-specific package managers (apt/Homebrew).
  • ReadMACAddressAction: Reads the MAC address of a specified network interface.

Improved Categorization:

  • Added an Action Categories Summary section to group actions by themes (e.g., File Operations, Docker Operations, System Management).

Practical Examples:

  • Replaced inline code examples with references to example tasks in the tasks/ directory, such as tasks.NewFileOperationsTask() and tasks.NewCompressionOperationsTask(). [1] [2]

Updates in README.md:

Example Tasks:

  • Introduced example tasks for workflows such as file operations, compression, package management, system management, and utility operations. These tasks demonstrate real-world usage patterns.

Reflecting Changes:

  • Updated the number of built-in actions from "19+" to "24+" and added descriptions for new workflows like package management and compression operations.

Code Simplification:

  • Replaced manual task creation with references to example task functions, simplifying the main function implementation.

These changes improve the usability of the documentation, provide better examples, and introduce new functionality to the task-engine.

@codecov
Copy link

codecov bot commented Jul 19, 2025

Codecov Report

Attention: Patch coverage is 80.84507% with 136 lines in your changes missing coverage. Please review.

Project coverage is 82.31%. Comparing base (a1bce26) to head (7bedbec).

Files with missing lines Patch % Lines
actions/file/delete_path_action.go 76.25% 29 Missing and 9 partials ⚠️
actions/file/copy_file_action.go 72.51% 25 Missing and 11 partials ⚠️
actions/file/path_validation.go 55.26% 16 Missing and 1 partial ⚠️
actions/file/compress_file_action.go 87.62% 8 Missing and 4 partials ⚠️
actions/file/decompress_file_action.go 89.47% 8 Missing and 4 partials ⚠️
actions/system/update_packages_action.go 93.40% 6 Missing ⚠️
action.go 0.00% 5 Missing ⚠️
actions/file/read_file_action.go 89.58% 4 Missing and 1 partial ⚠️
actions/file/write_file_action.go 77.27% 4 Missing and 1 partial ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##             main       #4       +/-   ##
===========================================
+ Coverage   67.24%   82.31%   +15.06%     
===========================================
  Files          28       29        +1     
  Lines        1151     1600      +449     
===========================================
+ Hits          774     1317      +543     
+ Misses        345      229      -116     
- Partials       32       54       +22     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ndizazzo ndizazzo force-pushed the feature/new-actions-doc-refactor branch 2 times, most recently from 9f54b56 to 77c0765 Compare July 19, 2025 05:49
@ndizazzo ndizazzo force-pushed the feature/new-actions-doc-refactor branch from 77c0765 to 4774e50 Compare July 19, 2025 05:58
@ndizazzo ndizazzo merged commit d11901a into main Jul 19, 2025
9 checks passed
@ndizazzo ndizazzo deleted the feature/new-actions-doc-refactor branch July 19, 2025 06:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants