Liquibase Db Doc Action

⚠️ VERSION SUPPORT NOTICE: This action will continue to be supported for Liquibase 4.x. Starting with Liquibase 5.x, it will no longer be supported.

Migration to liquibase/setup-liquibase: Available for Liquibase versions 4.32.0 and above. If you're using an older version, upgrade your Liquibase version first.

Migration Guide

Current Approach (Liquibase 4.x)

- uses: liquibase-github-actions/db-doc@v4.33.0
  with:
    # your parameters here

Recommended Approach (Liquibase 4.32.0+)

- uses: liquibase/setup-liquibase@v1
  with:
    version: '4.33.0'  # Requires 4.32.0 or higher
    edition: 'oss'
- run: liquibase db-doc # add your parameters as CLI flags

Migration Steps

1. Check your Liquibase version: Ensure you're using 4.32.0 or higher
2. If using older version: Update to 4.32.0+ first using the current micro actions
3. Then migrate: Switch to setup-liquibase action

---

Official GitHub Action to run Liquibase Db Doc in your GitHub Action Workflow. For more information on how db doc works visit the Official Liquibase Documentation.

Db Doc

Generates JavaDoc documentation for the existing database and changelogs

Usage

steps:
- uses: actions/checkout@v3
- uses: liquibase-github-actions/db-doc@v4.33.0
  with:
    # The root changelog file
    # string
    # Required
    changelogFile: ""

    # The directory where the documentation is generated
    # string
    # Required
    outputDirectory: ""

    # The JDBC database connection URL
    # string
    # Required
    url: ""

    # Context string to use for filtering
    # string
    # Optional
    contextFilter: ""

    # The default catalog name to use for the database connection
    # string
    # Optional
    defaultCatalogName: ""

    # The default schema name to use for the database connection
    # string
    # Optional
    defaultSchemaName: ""

    # The JDBC driver class
    # string
    # Optional
    driver: ""

    # The JDBC driver properties file
    # string
    # Optional
    driverPropertiesFile: ""

    # Label expression to use for filtering
    # string
    # Optional
    labelFilter: ""

    # Password to use to connect to the database
    # string
    # Optional
    password: ""

    # Database schemas to include objects from in reporting
    # string
    # Optional
    schemas: ""

    # Username to use to connect to the database
    # string
    # Optional
    username: ""

Secrets

It is a good practice to protect your database credentials with GitHub Secrets

Optional Liquibase Global Inputs

The liquibase db doc action accepts all valid liquibase global options as optional parameters. A full list is available in the official Liquibase Documentation.

Example

steps:
  - uses: actions/checkout@v3
  - uses: liquibase-github-actions/db-doc@v4.33.0
    with:
      changelogFile: ""
      outputDirectory: ""
      url: ""
      headless: true
      licenseKey: ${{ secrets.LIQUIBASE_LICENSE_KEY }}
      logLevel: INFO

Feedback and Issues

This action is automatically generated. Please submit all feedback and issues with the generator repository.