Skip to content

docs(components): add changelog commit history #4601

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 6, 2025

Conversation

hywax
Copy link
Contributor

@hywax hywax commented Jul 25, 2025

❓ Type of change

  • πŸ“– Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

The vueuse documentation contains a history of commits by function. I use this quite often to see what has been changed. I'm probably not the only one. That's why I decided to transfer this functionality to nuxt-ui.

image

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@hywax hywax requested a review from benjamincanac as a code owner July 25, 2025 19:29
Copy link

pkg-pr-new bot commented Jul 25, 2025

npm i https://pkg.pr.new/@nuxt/ui@4601

commit: 1c6e857

@HugoRCD
Copy link
Member

HugoRCD commented Jul 25, 2025

@hywax So I don't know if it's used a lot, but it looks cool. On the other hand, you display all the commits? not just a certain number?

@hywax
Copy link
Contributor Author

hywax commented Jul 25, 2025

@hywax So I don't know if it's used a lot, but it looks cool. On the other hand, you display all the commits? not just a certain number?

The last 1,000 commits are taken. Made following the example of vueuse. This is enough to get the last history for each component.

@hywax
Copy link
Contributor Author

hywax commented Jul 25, 2025

If there was a commit but no release, the β€œpending for release” section will appear

@benjamincanac benjamincanac changed the title docs: add changelog commit history docs(components): add changelog commit history Jul 28, 2025
@benjamincanac
Copy link
Member

@hywax It's awesome! I've updated the design a bit, let me know what you think 😊

Is it necessary to store the author_name / author_email though? πŸ€”

@hywax
Copy link
Contributor Author

hywax commented Aug 5, 2025

Email and name are required if avatars of people will ever be displayed. If this is not planned, then it is not necessary.

@benjamincanac benjamincanac merged commit 39bafe9 into nuxt:v3 Aug 6, 2025
@benjamincanac
Copy link
Member

Thanks @hywax! 😊

@benjamincanac
Copy link
Member

benjamincanac commented Aug 6, 2025

@hywax It seems I merged a bit too quick, the git history is not available when building 😬

@hywax
Copy link
Contributor Author

hywax commented Aug 6, 2025

@benjamincanac you just need to turn it on

https://github.com/nuxt/ui/blob/v3/.github/workflows/docs.yml#L22

steps:
      - uses: actions/checkout@v4
+       with:
+         fetch-depth: 0      

Example: https://github.com/vueuse/vueuse/blob/main/.github/workflows/publish.yml#L16-L19

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants