docs(README): Adds badges, logo and repo explanation to README #136
Conversation
|
@divyenduz maybe you can explain the |
|
I also added badges for the latest stable version, the number of installs, and the rating on the marketplace. All of these badges include a link to the prisma extension. What do you think about them? |
|
I like them, pretty useful. |
Co-authored-by: Jan Piotrowski <piotrowski+github@gmail.com>
|
Update: added some more information how and when versions are published |
Readme.md
Outdated
|
|
||
| There is a stable version `prisma` and an unstable version `prisma-dev`. The stable one is published as ["Prisma" in the VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=Prisma.prisma), the unstable one as ["Prisma Dev"](https://marketplace.visualstudio.com/items?itemName=Prisma.prisma-dev). An automated publish runs every 5 minutes calling the `check-update.sh` script: | ||
| - stable channel: | ||
| - required versions/values in `package.json` are changed and published |
There was a problem hiding this comment.
In the beginning of this run, the CI job checks for Prisma stable version and scripts/prisma_version_stable contents to be the same. If they are not the same, it makes the required version changes and proceeds further in the job
Readme.md
Outdated
| There is a stable version `prisma` and an unstable version `prisma-dev`. The stable one is published as ["Prisma" in the VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=Prisma.prisma), the unstable one as ["Prisma Dev"](https://marketplace.visualstudio.com/items?itemName=Prisma.prisma-dev). An automated publish runs every 5 minutes calling the `check-update.sh` script: | ||
| - stable channel: | ||
| - required versions/values in `package.json` are changed and published | ||
| - changes are not committed |
There was a problem hiding this comment.
scripts/prisma_version_stable is one file that is committed by the stable CI job. That enables the future runs to know if an extension version is already published for a specific Prisma CLI version.
Readme.md
Outdated
| - required versions/values in `package.json` are changed and published | ||
| - changes are not committed | ||
| - unstable channel: | ||
| - required versions/values in `package.json` are changed and published |
There was a problem hiding this comment.
Same as above but the file checked in this case is scripts/prisma_version_unstable
There was a problem hiding this comment.
One small change, the unstable section doesn't mention anymore that it commits the versions in package.json files too.
This internal slack discussion of renaming the unstable channel extension to "insider" probably also affects this PR.
Readme.md
Outdated
| - required versions/values in `package.json` are changed and published | ||
| - changes are committed | ||
| There is a stable version `prisma` and an unstable version `prisma-dev`. The stable one is published as ["Prisma" in the VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=Prisma.prisma), the unstable one as ["Prisma Dev"](https://marketplace.visualstudio.com/items?itemName=Prisma.prisma-dev). An automated publish runs every 5 minutes calling the `check-update.sh` script. | ||
| In the beginning of this run, the CI job checks for Prisma stable version and `scripts/prisma_version_stable` contents to be the same. If they are not the same, it makes the required version changes and proceeds further in the job. `scripts/prisma_version_stable` is a file that is committed by the stable CI job. That enables the future runs to know if an extension version is already published for a specific Prisma CLI version. The same workflow is done for Prisma unstable version, where the file checked in that case is `scripts/prisma_version_unstable`. |
There was a problem hiding this comment.
The same workflow is done for Prisma unstable version - and in addition it also commits the respective package.json files
There was a problem hiding this comment.
About renaming of the unstable version, we might change the readme after that is done, since there will be another PR adjusting the scripts and so on anyway.
janpio
changed the title
closes #135
Adds badges, logo and repo explanation to README