A GitHub Action that reads one or more Java-style .properties files and exposes every key-value pair as a step output.

steps:
  - name: Checkout
    uses: actions/checkout@v6

  - name: Read config
    id: props
    uses: ActionCommons/read-properties@v1
    with:
      files: config/app.properties

  - name: Use a value
    run: echo "${{ steps.props.outputs['app.version'] }}"

- name: Read multiple files
  id: props
  uses: ActionCommons/read-properties@v1
  with:
    files: |
      config/database.properties
      config/app.properties

The properties filter applies to every file listed in files.

- name: Read selected properties
  id: props
  uses: ActionCommons/read-properties@v1
  with:
    files: |
      config/database.properties
      config/app.properties
    properties: |
      db.host
      app.version

Outputs are set dynamically at runtime as <stem>.<property-key>, where stem is the filename without its extension.

Because output keys contain dots, use bracket notation:

${{ steps.props.outputs['config.db.host'] }}

When two files share the same name (but live in different directories), the first keeps the plain stem and each subsequent file receives a 1-based numeric suffix:

Copy .env.example to .env and set your input values, then run:

npx @github/local-action . src/main.ts .env

Input names follow the INPUT_<NAME> convention (hyphens are not converted to underscores):

# .env
ACTIONS_STEP_DEBUG=true
INPUT_FILES=config/app.properties
INPUT_PROPERTIES=app.version

npm install

Update packages to the latest version allowed by the version range specified in the package.json file.

npm update

npm audit

Check the registry to see if any of the installed packages have newer versions available.

npm outdated

Remove "extraneous" packages—those that are installed in node_modules but no longer listed in package.json

npm prune

Simplify the dependency tree by moving duplicated nested dependencies further up the hierarchy.

npm dedupe

Display an ASCII tree of all installed packages and their dependencies.

npm list (or npm ls)
npm ls -g --depth=0   # to see only top-level global packages

Check why a specific package is installed by visualizing the dependency chain leading to it.

npm explain <package> (formerly npm why)

Run a series of diagnostic tests to ensure the npm installation and environment (like the cache and registry access) are working correctly.

npm doctor

Clear the internal npm cache, which can resolve "ghost" installation errors.

npm cache clean --force

Perform a "clean" install by deleting node_modules and strictly following the package-lock.json file (Designed for CI environments).

npm ci

Create a symbolic link for a package being developed locally, allowing use in another project as if it were published.

npm link

Print detailed metadata about a package from the registry without installing it, such as available versions or its documentation.

npm view <package-name>