# jetstream-gh-action

**Repository Path**: nats-io/jetstream-gh-action

## Basic Information

- **Project Name**: jetstream-gh-action
- **Description**: Collection of JetStream related Actions for GitHub Actions
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-07-25
- **Last Updated**: 2026-11-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# NATS JetStream GitHub Action Pack

This is a collection of [GitHub Actions](https://github.com/features/actions) to interact with NATS [JetStream](https://github.com/nats-io/jetstream#readme).

|Action|Description|
|------|-----------|
|[nats-io/jetstream-gh-action/validate/stream@main](https://github.com/nats-io/jetstream-gh-action/tree/main/validate/stream)|Validates Stream Configuration|
|[nats-io/jetstream-gh-action/validate/consumer@main](https://github.com/nats-io/jetstream-gh-action/tree/main/validate/consumer)|Validates Consumer Configuration|
|[nats-io/jetstream-gh-action/create/stream@main](https://github.com/nats-io/jetstream-gh-action/tree/main/create/stream)|Creates Streams|
|[nats-io/jetstream-gh-action/create/consumer@main](https://github.com/nats-io/jetstream-gh-action/tree/main/create/consumer)|Creates Consumers|
|[nats-io/jetstream-gh-action/update/stream@main](https://github.com/nats-io/jetstream-gh-action/tree/main/update/stream)|Updates Streams|
|[nats-io/jetstream-gh-action/delete/stream@main](https://github.com/nats-io/jetstream-gh-action/tree/main/delete/stream)|Deletes Streams|
|[nats-io/jetstream-gh-action/delete/consumer@main](https://github.com/nats-io/jetstream-gh-action/tree/main/delete/consumer)|Deletes Consumers|
|[nats-io/jetstream-gh-action/eval/stream@main](https://github.com/nats-io/jetstream-gh-action/tree/main/eval/stream)|Evaluate Stream state|
|[nats-io/jetstream-gh-action/eval/consumer@main](https://github.com/nats-io/jetstream-gh-action/tree/main/eval/consumer)|Evaluate Consumer state|
|[nats-io/jetstream-gh-action/purge/stream@main](https://github.com/nats-io/jetstream-gh-action/tree/main/purge/stream)|Purge all data from a Stream|
|[nats-io/jetstream-gh-action@main](https://github.com/nats-io/jetstream-gh-action/)|Publish to a JetStream Stream|

See individual action directory for detailed usage instructions.

## JetStream Service In Workflow

JetStream can be run within the workflow job as a local service, here's an example starting the Service and creating a Stream in it.

```yaml
on: push
name: orders
jobs:
  orders:
    runs-on: ubuntu-latest
    services:
      # starts a JetStream service locally known as "jetstream" on the network
      jetstream:
        image: nats:latest

      # creates a stream on the "jetstream:4222" server started above
      - name: orders_stream
        uses: nats-io/jetstream-gh-action/create/stream@main
        with:
          config: ORDERS.json
          server: jetstream:4222
```

This server is available to all steps in the job that hosts it.

## Publishing Messages

Messages can be published to a Stream, or any NATS subject, using the base action.

### Usage

```yaml
on: push
name: consumer
jobs:
  consumer_validate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@main
      - name: hello
        uses: nats-io/jetstream-gh-action@main
        with:
          subject: ORDERS.deploy
          message: Published new deployment via "${{ github.event_name }}" in "${{ github.repository }}"
          should_ack: 1
          server: nats.example.net:4222
```

### Inputs

|Input|Description|
|-----|-----------|
|`subject`|The subject to publish to (required)|
|`message`|The message payload (required)|
|`should_ack`|If a positive response from JetStream is required for success|
|`server`|Comma separated list of NATS Server URLs (required)|
|`username`|Username or Token to connect with|
|`password`|Password to connect with|
|`credentials`|Path to a file holding NATS credentials|

### Outputs

|Output|Description|
|------|-----------|
|`response`|Response received or error body|