Skip to content

Documentation Improvement: Clarify Action Usage Example #37

@temptationkentos57

Description

@temptationkentos57

Issue

The usage example in the README for the GitHub Action ci-storage lacks a complete example for the action input parameter. It only includes a placeholder but does not show the actual values that can be used (e.g., 'store' or 'load'). This could lead to confusion for new users trying to implement the action.

Suggestion

It would be beneficial to provide a complete example along with a brief explanation for each of the possible values for the action parameter. For example:

- uses: dimikot/ci-storage@v1
  with:
    # Action: either 'store' or 'load'.
    action: 'store'  # Stores the current work directory to the remote storage.
    storage-host: 'user@host'
    # Other parameters...

This improvement will enhance the clarity of the README and facilitate easier adoption of the action by providing a concrete usage scenario.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions