Commitd6c4d47

and

authored

fix: add version information to default docs links (#14205)

add version information to default docs links---------Co-authored-by: Kayla Washburn-Love <mckayla@hey.com>

1 parent2e05329 commitd6c4d47Copy full SHA for d6c4d47

File tree

+44

-17

lines changed

+44

-17

lines changed

Lines changed: 1 addition & 15 deletions

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@ import { CoderIcon } from "components/Icons/CoderIcon";`
`10`	`10`	`import{Loader}from"components/Loader/Loader";`
`11`	`11`	`import{Margins}from"components/Margins/Margins";`
`12`	`12`	`import{Stack}from"components/Stack/Stack";`
	`13`	`+import{getStaticBuildInfo}from"utils/buildInfo";`
`13`	`14`
`14`	`15`	`constfetchDynamicallyImportedModuleError=`
`15`	`16`	`"Failed to fetch dynamically imported module";`
`@@ -116,21 +117,6 @@ export const RuntimeErrorState: FC<RuntimeErrorStateProps> = ({ error }) => {`
`116`	`117`	`);`
`117`	`118`	`};`
`118`	`119`
`119`		`-// During the build process, we inject the build info into the HTML`
`120`		`-constgetStaticBuildInfo=()=>{`
`121`		`-constbuildInfoJson=document`
`122`		`-.querySelector("meta[property=build-info]")`
`123`		`-?.getAttribute("content");`
`124`		`-`
`125`		`-if(buildInfoJson){`
`126`		`-try{`
`127`		`-returnJSON.parse(buildInfoJson)asBuildInfoResponse;`
`128`		`-}catch{`
`129`		`-returnundefined;`
`130`		`-}`
`131`		`-}`
`132`		`-};`
`133`		`-`
`134`	`120`	`conststyles={`
`135`	`121`	`root:{`
`136`	`122`	`paddingTop:32,`

Lines changed: 24 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,24 @@`
	`1`	`+importtype{BuildInfoResponse}from"api/typesGenerated";`
	`2`	`+`
	`3`	`+letCACHED_BUILD_INFO:BuildInfoResponse\|undefined;`
	`4`	`+`
	`5`	`+// During the build process, we inject the build info into the HTML`
	`6`	`+exportconstgetStaticBuildInfo=()=>{`
	`7`	`+if(CACHED_BUILD_INFO){`
	`8`	`+returnCACHED_BUILD_INFO;`
	`9`	`+}`
	`10`	`+`
	`11`	`+constbuildInfoJson=document`
	`12`	`+.querySelector("meta[property=build-info]")`
	`13`	`+?.getAttribute("content");`
	`14`	`+`
	`15`	`+if(buildInfoJson){`
	`16`	`+try{`
	`17`	`+CACHED_BUILD_INFO=JSON.parse(buildInfoJson)asBuildInfoResponse;`
	`18`	`+}catch{`
	`19`	`+returnundefined;`
	`20`	`+}`
	`21`	`+}`
	`22`	`+`
	`23`	`+returnCACHED_BUILD_INFO;`
	`24`	`+};`

Lines changed: 19 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,20 @@`
`1`		`-constDEFAULT_DOCS_URL="https://coder.com/docs";`
	`1`	`+import{getStaticBuildInfo}from"./buildInfo";`
	`2`	`+`
	`3`	`+functiondefaultDocsUrl():string{`
	`4`	`+constdocsUrl="https://coder.com/docs";`
	`5`	`+// If we can get the specific version, we want to include that in default docs URL.`
	`6`	`+letversion=getStaticBuildInfo()?.version;`
	`7`	`+if(!version){`
	`8`	`+returndocsUrl;`
	`9`	`+}`
	`10`	`+`
	`11`	`+// Strip the postfix version info that's not part of the link.`
	`12`	`+consti=version?.indexOf("-")??-1;`
	`13`	`+if(i>=0){`
	`14`	`+version=version.slice(0,i);`
	`15`	`+}`
	`16`	+return`${docsUrl}/@${version}`;
	`17`	`+}`
`2`	`18`
`3`	`19`	`// Add cache to avoid DOM reading all the time`
`4`	`20`	`letCACHED_DOCS_URL:string\|undefined;`
`@@ -12,8 +28,9 @@ const getBaseDocsURL = () => {`
`12`	`28`	`constdocsUrl=document`
`13`	`29`	`.querySelector<HTMLMetaElement>('meta[property="docs-url"]')`
`14`	`30`	`?.getAttribute("content");`
	`31`	`+`
`15`	`32`	`constisValidDocsURL=docsUrl&&isURL(docsUrl);`
`16`		`-CACHED_DOCS_URL=isValidDocsURL ?docsUrl :DEFAULT_DOCS_URL;`
	`33`	`+CACHED_DOCS_URL=isValidDocsURL ?docsUrl :defaultDocsUrl();`
`17`	`34`	`}`
`18`	`35`	`returnCACHED_DOCS_URL;`
`19`	`36`	`};`

Comments

(0)