cloudinary-community / next-cloudinary

⚡️ High-performance image delivery and uploading at scale in Next.js powered by Cloudinary.

https://next.cloudinary.dev

MIT License

257 stars 75 forks source link

feat: implement dynamic README values using markdown-magic & markdown-magic-package-json #541

Closed vickywane closed 1 month ago

vickywane commented 1 month ago

Description

This PR aims to close #513 by making changes to dynamically add release versions into the markdown documentation.

Fixes #513

Type of change

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[x] Fix or improve the documentation
[x] This change requires a documentation update

Checklist

[x] I have followed the contributing guidelines of this project as mentioned in CONTRIBUTING.md
[x] I have created an issue ticket for this PR
[x] I have checked to ensure there aren't other open Pull Requests for the same update/change?
[x] I have performed a self-review of my own code
[x] I have run tests locally to ensure they all pass
[x] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes needed to the documentation

vercel[bot] commented 1 month ago

@vickywane is attempting to deploy a commit to the Cloudinary DevX Team on Vercel.

A member of the Team first needs to authorize it.

vickywane commented 1 month ago

@colbyfayock This PR isn't completed yet, however it has provided a sense of direction to solve this.

I have tried using the markdown-magic and markdown-magic-package-json packages to dynamically inject values from the package.json file into the README file. This process will require executing the generate-readme command added to the package.json upon every successful release. ( this can be executed in the CI pipeline or commit hook to avoid manual work ).

At the moment, the markdown-magic and markdown-magic-package-json packages are not finding the specific values but I wanted to share this update to receive early feedback on this process. Also, I can try to remove the two packages and write a JS script to manually inject strings to the README file.

colbyfayock commented 1 month ago

hey @vickywane thanks for raising the PR

i think the goal here isn't necessarily the README it's to add the version number into the documentation website

https://next.cloudinary.dev/

i was thinking we may be able to import the package.json from the package and reference the version number in the navigation or something

colbyfayock commented 1 month ago

@vickywane any updates?

vickywane commented 1 month ago

hey @vickywane thanks for raising the PR

i think the goal here isn't necessarily the README it's to add the version number into the documentation website

https://next.cloudinary.dev/

i was thinking we may be able to import the package.json from the package and reference the version number in the navigation or something

Ah, I see!

I got the wrong idea then.

Adding it to the documentation website should be much easier since we have JavaScript. I will proceed with that.

vickywane commented 1 month ago

@colbyfayock I have made adjustments to this PR to add the current version from the next-cloudinary package into the hero component of the docs website.

I have also removed the markdown-magic and markdown-magic-package-json packages.

Screenshot 2024-10-14 at 22 40 54

vercel[bot] commented 1 month ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
next-cloudinary	✅ Ready (Inspect)	Visit Preview	Oct 15, 2024 0:33am

colbyfayock commented 1 month ago

thanks for your contribution. this PR is eligible for free Cloudinary Hackatoberfest swag. Please send me an email at hacktoberfest@cloudinary.com with your name, GitHub username, and a link to the PR where I'll send further instructions.

Happy Hacktoberfest!

colbyfayock commented 1 month ago

@all-contributors please add @vickywane for doc

allcontributors[bot] commented 1 month ago

@colbyfayock

I've put up a pull request to add @vickywane! :tada:

github-actions[bot] commented 1 month ago

:tada: This PR is included in version 6.15.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

github-actions[bot] commented 1 month ago

:tada: This PR is included in version 7.0.0-beta.4 :tada:

The release is available on:

Your semantic-release bot :package::rocket: