✨ Show version number in app #601
Conversation
|
@arcticFox-git is attempting to deploy a commit to the rallly Team on Vercel. A member of the Team first needs to authorize it. |
|
I've been having a look at this and I can see it's a bit more complicated than I originally anticipated so don't worry if you need to drop this. I'll be looking into it soon. |
|
Hi @lukevella, yeah I might leave it to you from here, but I did learn a lot from working through this so very grateful for that! If it helps, below is the gist of what worked and what didn't. If NEXT_PUBLIC_APP_VERSION is set as an environment variable in the root directory, it will successfully display in the app through yarn dev, yarn build etc, but not through docker build. If it is set in the apps/web directory, it will work through docker build but not through yarn. Feel free to delete this PR at your convenience! |
lukevella
changed the title
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
| import * as React from "react"; | ||
| import process from "process"; |
There was a problem hiding this comment.
| import process from "process"; |
| const [appVersion, setAppVersion] = useState(""); | ||
|
|
||
| useEffect(() => { | ||
| if (process.env.NEXT_PUBLIC_APP_VERSION !== undefined) { | ||
| setAppVersion('v' + process.env.NEXT_PUBLIC_APP_VERSION || ''); | ||
| } | ||
| }, []); |
There was a problem hiding this comment.
It's not necessary to use any hooks for this. You can define appVersion outside of Footer.
const appVersion = process.env.NEXT_PUBLIC_APP_VERSION;
const Footer...
apps/web/Dockerfile
Outdated
| RUN apt-get update && apt-get install -y jq | ||
| RUN echo "NEXT_PUBLIC_APP_VERSION=$(jq -r '.version' package.json)" > apps/web/.env |
There was a problem hiding this comment.
We don't need .env in our Dockerfile. Also I think we can use grep to get the version so we don't need to install jq.
| RUN apt-get update && apt-get install -y jq | |
| RUN echo "NEXT_PUBLIC_APP_VERSION=$(jq -r '.version' package.json)" > apps/web/.env | |
| ENV NEXT_PUBLIC_APP_VERSION $(cat package.json | grep '"version"' | cut -d'"' -f4) |
Also, this probably needs to be in the runner stage further down.
|
I think I've found a solution for this though it's not quite what I originally had in mind. Rather than trying to set the value of Thanks for your help with this @arcticFox-git. |
Resolves #588 - Display version number somewhere on the app
package.jsonfile and add it to an.envfile that next.js can pull from. This took a while to understand, the docker container environmental variables pulls from the root.envbut next.js seems to like an.envfile inapp/apps/web(at least in the way that I was using it).footer.tsxto add the version number (in the form vX.X.X so as to be language agnostic) below the RALLLY logo.NEXT_PUBLIC_APP_VERSIONenvironment variable is undefined, then the app will look like normal without anything additional showing. This pertains to people runningyarn run dev, as then next.js appears to pull from the root.envinstead, and so if they do not set this in their.envthen it would be undefined.Overall, I was a little confused with the
.envscope based on the README. Thesample.envis located in apps/web/ however the README says to copy it usingcp sample.envaftercdinto the rallly directory.This is my first pull request to a public repo, so open to feedback on how I went about this process and if I have done anything incorrectly.