Skip to content
Permalink
578453f589
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

tailwind-crawler/README.md

Go to file
 
 
Cannot retrieve contributors at this time
Tailwind UI Crawler Action Usage Advanced
55 lines (43 sloc) 6.44 KB
Raw Blame

Tailwind UI Crawler Action

Automate the crawling and cataloging of the Tailwind UI components

GitHub Actions Example/Test

Usage

As a part of your GitHub Actions workflow, add a new step as follows:

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

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

We strongly advise utilizing GitHub Actions secrets to securely store your TailwindUI email and password.

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

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 }})
commitmessage The message to commit with in the output repository No Defaults to Update tailwindui.com
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.