https://github.com/seonghun-dev/flyway-naming-checker

Flyway Naming Checker
https://github.com/seonghun-dev/flyway-naming-checker

Last synced: 9 days ago
JSON representation

Flyway Naming Checker

• Host: GitHub
• URL: https://github.com/seonghun-dev/flyway-naming-checker
• Owner: seonghun-dev
• License: mit
• Created: 2023-11-16T20:07:02.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-17T02:57:36.000Z (6 months ago)
• Last Synced: 2024-11-01T09:10:21.354Z (2 months ago)
• Language: Rust
• Homepage:
• Size: 20.5 KB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Flyway Naming Convention Checker

![GitHub Actions](https://img.shields.io/badge/GitHub%20Actions-enabled-brightgreen)

[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)

GitHub Actions CI workflow for validating Flyway migration script names to ensure they follow the naming convention. 

This Github action generated from [dbanty/rust-github-action-template](https://github.com/dbanty/rust-github-action-template).

## Description

Flyway's file convention is clearly specified. This action checks that all files conform to the flyway file convention.

[Flyway: Naming Patterns Matter | Redgate](https://www.red-gate.com/blog/database-devops/flyway-naming-patterns-matter)

 **Make sure to write path. path means the migration file path.**

 

 Do not start with /. It should be in the form of 'db/migration' instead of '/db/migration'.

![flyway_naming](https://github.com/seonghun-dev/flyway-naming-checker/assets/80201773/7d448c33-125f-45b2-a6f5-027264b9a9d6)

## Example

To use this GitHub Actions workflow in your repository.

Create a YAML file (e.g., `.github/workflows/flyway-naming-check.yml`) with the following content:

```yaml

name: Flyway Naming Check

on:

  push:

    branches: [ "main" ]

  pull_request:

    branches: [ "main" ]

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v3

      - name: flyway-naming-checker

        uses: seonghun-dev/[email protected]

        with:

          path: 'db/migartion' # Adjust the path to match your migration script location

```

## Preview

This script verifies that all files in the current folder match flyway naming convention.