diff --git a/README.md b/README.md index 8d5bb38..2d0c7a8 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,14 @@ If you are using a domain or a subdomain, you need to completely remove the `bas [![](https://cdn.loom.com/sessions/thumbnails/256fac3d2bbb422b8e779ac1c8244d33-00001.gif)](https://www.loom.com/share/256fac3d2bbb422b8e779ac1c8244d33 "") +## New schema version + +If a new schema version comes out, this is what you will need to do. + +1. Create a new branch with the schema version as the branch name (for example, 1.1) +1. Open `.github/workflows/build-and-deploy.yml` and change the `on.push.branches` to match the new version `branches: [ 1.1 ]` then at the bottom of the file change the `target-folder` to match the version `target-folder: "1.1"` +1. Open `site/next.config.js` and change `env.schema` to match the version number, add the version number to the `env.listUrl` and append the version number to the `basePath` as well. + ## Discovery The tag below will hopefully make it easier for people to find your App Registry by clicking on [this github search link](https://github.com/search?q=in%3Areadme+sort%3Aupdated+-user%3Akasmtech+%22KASM-REGISTRY-DISCOVERY-IDENTIFIER%22&type=repositories). If you want to make it harder to find your repository for some reason, just remove this section. diff --git a/site/README.md b/site/README.md index 29c06b1..b12f3e3 100644 --- a/site/README.md +++ b/site/README.md @@ -32,17 +32,3 @@ You can check out [the Next.js GitHub repository](https://github.com/vercel/next The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. - -## New schema version - -If a new schema version comes out, this is what you will need to do. - -1. Create a new branch with the schema version as the branch name (for example, 1.1) -1. Open `.github/workflows/build-and-deploy.yml` and change the on: push: branches: to match the new version: -``` -on: - push: - branches: [ 1.1 ] -``` -then at the bottom of the file change the `target-folder` to match the version `target-folder: "1.1"` -1. Open `site/next.config.js` and change `env.schema` to match the version number, add the version number to the `env.listUrl` and append the version number to the `basePath` as well. \ No newline at end of file