You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
GitHub Packages uses the README from the root of the repository for all packages in the repository. If you want to have a specific README for a package in a monorepo, you can use a workaround.
The workaround is to temporarily move to the package directory, copy the package-specific README to the root, publish the package, and then move the README back. Here's how you can do it:
# Move to the package directorycd package
# Copy the package README to the root
cp README.md ../
# Publish the package
npm publish
# Restore the root README back
mv README.md packages/my-package/
This will ensure that the package-specific README is used when publishing the package to GitHub Packages. Remember to replace packages/my-package with the actual path to your package directory.
courtesy: Github co-pilot
The text was updated successfully, but these errors were encountered:
Remove image links from README of servers/lib. Put all the images in the documentation.
Correct READMEs for dtaas-web and libms docker images. A dedicated README is needed for each of the docker images. The filenames could be docker/WEB.md and docker/LIBMS.md. These files need to overwrite the top-level README in docker.yml workflow. It could be done on line-39 of docker.yml. The name of the file must come as parameter to the yaml (similar in technique to inputs.dockerfile.
Also remember to remove the docker-specific information from READMEs of libms and client packages. The idea is to have separate READMEs for docker and npm packages. These READMEs should only contain information for the matching github package.
GitHub Packages uses the README from the root of the repository for all packages in the repository. If you want to have a specific README for a package in a monorepo, you can use a workaround.
The workaround is to temporarily move to the package directory, copy the package-specific README to the root, publish the package, and then move the README back. Here's how you can do it:
This will ensure that the package-specific README is used when publishing the package to GitHub Packages. Remember to replace
packages/my-package
with the actual path to your package directory.courtesy: Github co-pilot
The text was updated successfully, but these errors were encountered: