unjs / undocs

Minimal Documentation theme and CLI for shared usage across UnJS projects.

Home Page:https://undocs.pages.dev/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Add releases page that leverages `ungh`

cpreston321 opened this issue ยท comments

Describe the feature

Releases Page

Since we already capture the github repo org/repo we can then leverage that to make something like.

CleanShot 2024-01-30 at 14 50 12@2x

Deps

  • date-dns

Endpoints to use:


Could make a simpler landing page but I really like the design and approach they took but just an idea.

Additional information

  • Would you be willing to help implement this feature?

Tasks

Seems a very good idea! If you feel up to it, feel free to self-assign and work on this page!

@pi0 Work is pretty much done, if we want to leverage the ugh I will have to make a PR there to support repo/unjs/docs/pulls so we don't have to install another dep for Octokit. I will create issue and attach issue here to track ๐Ÿ‘๐Ÿผ

Thanks. If possible it would be better that we reply on default releases formating in release notes (generated during release with changelogen). They are already mapped to PRs with a reference.

@pi0 Only reason I said ungh was because it's more of interactive timeline changelog vs just a full changelog which is generated from README. Either way I can implement I think it's quite interesting seeing the pull requests and new releases on timeline vs just the log.

@pi0 what do you think?

CleanShot.2024-02-22.at.16.40.15.mp4

Oh sorry i have missed this @cpreston321 do you have your branch drafted somewhere still?

@pi0 The POC I drafted above was using ungh /releases endpoint but the problem was the cache would hold too long. If new releases. I think if we wanted to leverage we would need to figure how to clear the ungh cache. If not I will have to use the changelog file but doesn't have the date meta data tied to this.

I did not unfortunately create a branch for this. I can gather your thoughts then I re-implement it.

Having a branch would be good start to play around different ideas ๐Ÿ‘๐Ÿผ I am thinking that automd can sync back and add meta from github releases back to the CHANGELOG.md it can be most reliable source without worrying to be broken ๐Ÿ˜…

I will darft PR later today with ungh implementation then we work from there ๐Ÿ’ฏ

I am thinking that automd can sync back and add meta from github releases back to the CHANGELOG.md

I think that would be great :)