Skip to content

GregBrimble/tailwindui-crawler-action

Use this GitHub Action with your project

Add this Action to an existing workflow or create a new one.

View on Marketplace
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 

Tailwind UI Crawler Action

Automate the crawling and cataloging of the Tailwind UI components

GitHub Actions Example/Test

Usage

  1. Create a private GitHub repository.

  2. Add TAILWINDUI_EMAIL and TAILWINDUI_PASSWORD secrets to the GitHub repository.

  3. Optionally create a .env file with additional settings for the crawler.

  4. Create a new file .github/workflows/default.yml:

    name: Update
    on:
      workflow_dispatch: # On manual trigger
      schedule:
        - cron: "0 0 * * *" # Every day at midnight
    
    jobs:
      update:
        name: Update
        runs-on: ubuntu-latest
        steps:
          - name: Checkout
            uses: actions/checkout@v2
          - name: Run crawler
            uses: gregbrimble/tailwindui-crawler-action@v1.2.0
            with:
              email: ${{ secrets.TAILWINDUI_EMAIL }}
              password: ${{ secrets.TAILWINDUI_PASSWORD }}

    Read more about the schedule cron syntax in the official GitHub Actions documentation.

A live example can be found in .github/workflows/default.yml.

Email Notifications

To be emailed whenever there is a change to a component, simply setup GitHub Notifications on your repository.

Advanced

The following input options are available:

Name Value Required? Notes
email Your tailwindui.com account email address Yes
password Your tailwindui.com account password Yes
token A GitHub Personal Access Token with the repo scope No Defaults to the automatically provided {{ github.token }}
output The repository to output to
e.g. gregbrimble/tailwindui
No Defaults to the current repository ({{ github.repository }})
outputfolder The folder to output the crawled components in the output repository (i.e. the same function as the OUTPUT value in .env). No Defaults to ./
commitmessage The message to commit with in the output repository No Defaults to Update tailwindui.com
current_branch The branch in the current repository where .env can be found No Defaults to master
branch The branch to commit changes to No Defaults to master
force true | false No Defaults to false
actor The GitHub user to commit changes with
e.g. gregbrimble
No Defaults to the current user ({{ github.actor }})
repository The workspace repository
e.g. gregbrimble/tailwindui
No Defaults to the current repository ({{ github.repository }}). Should contain a .env file in the root.
crawler The repository of the crawler to use No Defaults to kiliman/tailwindui-crawler
crawlerref The ref (branch, tag or SHA) to checkout of the crawler repository No Defaults to master

Note: If using a separate private repository for the output, you must include a Personal Access Token in the token input, as the {{ github.token }} tokens are scoped to only the current repository.

About

Automate the crawling and cataloging of the Tailwind UI components

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages