themesberg / themesberg/flowbite-react

Docs: Only update the documentation when release

Open
#707 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

:books: documentation help wanted
Dominant language
TypeScript
Stars
2.1k
Forks
506
PR merge metrics
No merged PRs in 30d

Description

Describe the bug
Right now the documentation is being updated every time something changes on main branch, we need to change the CI workflow to only publish the docs when we have a new release.

To Reproduce
Steps to reproduce the behavior:

  1. Go to '...'
  2. Click on '....'
  3. Scroll down to '....'
  4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

System information:

  • Device:
  • Resolution:
  • OS:
  • Browser:
  • Version:

Project information:

  • Tailwind: 3.0.0
  • Flowbite: 1.4.7
  • Flowbite React: 0.1.2
  • Type: CRA

Additional context
Add any other context about the problem here.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the CI workflow that publishes the documentation and inspect how it is triggered from the main branch and releases. Update the workflow so documentation is published only for a new release, then verify that ordinary changes on main do not publish it.

Written by the indexing model from the issue text.

Assessment

Domain
ci-cd, documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.