Skip to content
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

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

vickywane
Copy link

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)
  • Fix or improve the documentation
  • This change requires a documentation update

Checklist

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

Copy link

vercel bot commented Oct 7, 2024

@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
Copy link
Author

@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
Copy link
Collaborator

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

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.

[Feature] Add current version in documentation
2 participants