rust-metadata-action

GitHub Action to collect Cargo/Rust project metadata (packages, features, publishable packages and a ready-to-use job matrix).

What it does

• Runs cargo metadata for the repository (or a specified manifest) and extracts useful information about packages and features.
• Exposes outputs for raw metadata and parsed lists so subsequent workflow steps can use them (for example to publish crates, run tests per-package, or build per-feature).

Inputs

• manifest-path: Path to Cargo.toml (default: "Cargo.toml").

Outputs

• metadata: Raw cargo metadata JSON.
• packages: JSON array (string) of package names, e.g. ["foo","bar"].
• publish: JSON array (string) of packages that can be published.
• matrix: JSON array (string) of command-line fragments suitable for use as a job matrix, e.g. ["--package=foo","--package=bar --features=foo"]

Examples

Example workflow snippet (consume outputs):

jobs:
  metadata:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - name: Get Rust metadata
        id: rustmeta
        uses: sv-tools/rust-metadata-action@v1
      - name: Show packages
        run: |
          echo "Packages: ${{ steps.rustmeta.outputs.packages }}"
          echo "Publishable: ${{ steps.rustmeta.outputs.publish }}"

Use as a job matrix

You can convert the matrix output into a job matrix for per-package jobs. The action emits matrix and publish as JSON; use fromJson to parse them.

jobs:
  prepare:
    runs-on: ubuntu-latest
    outputs:
      matrix: ${{ steps.rustmeta.outputs.matrix }}
      publish: ${{ steps.rustmeta.outputs.publish }}
    steps:
      - uses: actions/checkout@v5
      - name: Get matrix
        id: rustmeta
        uses: sv-tools/rust-metadata-action@v1
  test:
    needs: prepare
    runs-on: ubuntu-latest
    strategy:
      matrix:
        args: ${{ fromJson(needs.prepare.outputs.matrix) }}
    steps:
      - uses: actions/checkout@v5
      - name: Test per-package and per-feature
        run: cargo test ${{ matrix.args }}

  build:
    needs: prepare
    runs-on: ubuntu-latest
    strategy:
      matrix:
        args: ${{ fromJson(needs.prepare.outputs.matrix) }}
    steps:
      - uses: actions/checkout@v5
      - name: Build per-package
        run: cargo build ${{ matrix.args }}

  publish:
    needs: prepare
    runs-on: ubuntu-latest
    # use the 'publish' output (array of package names) as the matrix
    strategy:
      matrix:
        package: ${{ fromJson(needs.prepare.outputs.publish) }}
    steps:
      - uses: actions/checkout@v5
      - name: Publish crate (dry-run)
        run: cargo publish -p ${{ matrix.package }} --dry-run
      # Uncomment the real publish step once you're ready to publish for real
      #   run: cargo publish -p ${{ matrix.package }}

Notes

• The action expects a Rust workspace or package with a Cargo.toml. If your manifest lives in a subdirectory, set manifest-path accordingly.
• Outputs are emitted as JSON strings; use fromJson in workflows when you need native arrays or objects.

License

MIT licensed. See the bundled LICENSE file for more details.