https://github.com/tidalmigrations/tidal-code-action

https://github.com/tidalmigrations/tidal-code-action

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/tidalmigrations/tidal-code-action
• Owner: tidalmigrations
• License: mit
• Created: 2023-10-12T17:44:34.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-03-03T16:35:09.000Z (3 months ago)
• Last Synced: 2025-03-23T22:49:32.361Z (about 2 months ago)
• Language: TypeScript
• Size: 1.31 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Tidal Tools GitHub Action

[![GitHub Super-Linter](https://github.com/tidalmigrations/tidal-code-action/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter)

![CI](https://github.com/tidalmigrations/tidal-code-action/actions/workflows/ci.yml/badge.svg)

[![Coverage](./badges/coverage.svg)](./badges/coverage.svg)

Continually monitor and modernize your enterprise applications.

## Requirements

The action requires that you provide the login credentials for your

[Tidal Accelerator workspace](https://tidalcloud.com/accelerator/). We recommend

creating a `service user` specifically for using this action.

## Usage

To use this action, you need to provide the following inputs:

### Inputs

- `tidal-email` (required): The email for the Tidal Accelerator service user.

- `tidal-password` (required): The password for the Tidal Accelerator service

  user.

- `tidal-url` (required): The workspace URL for your Tidal Accelerator Account,

  for example, `https://workspace.tidal.cloud`.

- `app-id` (required): The ID of the application that is being this action is

  analyzing

### Example Workflow

Here is an example workflow that uses this GitHub Action:

```yaml

name: Tidal Accelerator Workflow

on:

  push:

    branches:

      - main

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout code

        uses: actions/checkout@v4

      - uses: tidalmigrations/tidal-code-action@v2

        with:

          tidal-email: ${{ secrets.TIDAL_EMAIL }}

          tidal-password: ${{ secrets.TIDAL_PASSWORD }}

          tidal-url: https://workspace.tidal.cloud

          app-id: 1

```

Make sure to store your sensitive information (like `TIDAL_EMAIL`,

`TIDAL_PASSWORD`) as

[secrets](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions)

in your repository settings to keep them secure.

## License

This GitHub Action is licensed under the [MIT License](./LICENSE)

Feel free to contribute, report issues, or request new features on

[GitHub](https://github.com/tidalmigrations/tidal-code-action).