Best Practices

Picking Version

The version that you are using should be one of the tagged versions as those have confirmed to be stable. To find the version you can check the action on the marketplace here. To get alerted to new version then check out dependabot.

Dependabot

To be alerted to new updates then you can set up dependabot. Create a file at .github/dependabot.yml with the following code and everyday your repo will be checked and if a new version is detected a pull request will be created with it.

# Set update schedule for GitHub Actions

version: 2
updates:

  - package-ecosystem: "github-actions"
    directory: "/"
    schedule:
      # Check for updates to GitHub Actions every weekday
      interval: "daily"

Advanced Configurations

If you are looking to deploy this action with a repo that has a lot of ignores or other arguments then I would recommend looking at the --config flag. To see examples of config files then check out this directory

Note About Paths

Because this action is a docker container action it means that only certain paths of the workflow space are made available to the action. Because of this all code that you want to be used by this action must be placed in the directory GITHUB_WORKSPACE environment variable is pointed (Defaults to /home/runner/work/my-repo-name/my-repo-name. For more information checkout WORKDIR documentation or #25