Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
cloud

GitHub Action

Create push subscription

0.4.0

Create push subscription

cloud

Create push subscription

Create a Google Pub/Sub push subscription for an Octue service

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Create push subscription

              
  uses: octue/create-push-subscription@0.4.0
Learn more about this action in octue/create-push-subscription

Choose a version

create-push-subscription

A GitHub action that creates a Google Pub/Sub push subscription for an Octue service.

Usage

To automatically create a push subscription on e.g. pull request merge / package release, add the following to your GitHub Actions workflow:

permissions:
  id-token: write
  contents: read

steps:
  - uses: actions/checkout@v4

  - name: Authenticate with Google Cloud
    uses: google-github-actions/auth@v0.8.1
    with:
      create_credentials_file: true
      workload_identity_provider: 'projects/<project-id>/locations/global/workloadIdentityPools/<pool-name>/providers/<provider-name>'
      service_account: '<service-account>@<project-name>.iam.gserviceaccount.com'

  - name: Get package version
    id: get-package-version
    run: echo "PACKAGE_VERSION=$(poetry version -s)" >> $GITHUB_OUTPUT
    # run: echo "PACKAGE_VERSION=$(python setup.py --version)" >> $GITHUB_OUTPUT  <- Use this instead if your package uses a `setup.py` file.

  - uses: octue/create-push-subscription@0.4.0
    with:
      project_name: project-name
      service_namespace: my-org
      service_name: my-service
      service_revision_tag: ${{ steps.get-package-version.outputs.PACKAGE_VERSION }}  # optional
      push_endpoint: https://example.com/endpoint
      expiration_time: 86400  # optional