feat: Add pages deployment variable logic and fixes in github pages yaml files (#1337)

Hristo313 · web-flow · commit c75d9c7a9d7a · 2024-11-21T09:39:46.000+02:00
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "igniteui-cli",
-  "version": "14.2.3",
+  "version": "14.2.4-beta.0",
   "description": "CLI tool for creating Ignite UI projects",
   "keywords": [
     "CLI",
@@ -78,8 +78,8 @@
     "all": true
   },
   "dependencies": {
-    "@igniteui/angular-templates": "~18.2.1423",
-    "@igniteui/cli-core": "~14.2.3",
+    "@igniteui/angular-templates": "~18.2.1424-beta.0",
+    "@igniteui/cli-core": "~14.2.4-beta.0",
     "@inquirer/prompts": "^5.4.0",
     "@types/yargs": "^17.0.33",
     "chalk": "^5.3.0",
diff --git a/packages/cli/templates/react/igr-ts/projects/_base/files/__dot__github/workflows/github-pages.yml b/packages/cli/templates/react/igr-ts/projects/_base/files/__dot__github/workflows/github-pages.yml
@@ -8,14 +8,17 @@ on:
 
 jobs:
   build-and-deploy:
-    # Deactivate the workflow. Will be changed when AB is ready
-    if: false
+    if: $(yamlGenerateDeploymentScript) == true
     runs-on: ubuntu-latest
 
     permissions:
       pages: write
       id-token: write
 
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
     strategy:
       matrix:
         node-version: [22.x]
diff --git a/packages/cli/templates/react/igr-ts/projects/_base/index.ts b/packages/cli/templates/react/igr-ts/projects/_base/index.ts
@@ -42,7 +42,8 @@ export class BaseIgrTsProject implements ProjectTemplate {
 			"dot": ".",
 			"path": name,
 			"projectTemplate": this.id,
-			"yamlDefaultBranch": this.id === "base" ? "<%=yaml-default-branch%>" : "main"
+			"yamlDefaultBranch": this.id === "base" ? "<%=yaml-default-branch%>" : "main",
+			"yamlGenerateDeploymentScript": "<%=yaml-generate-deployment-script%>"
 		};
 	}
 }
diff --git a/packages/cli/templates/webcomponents/igc-ts/projects/_base/files/__dot__github/workflows/github-pages.yml b/packages/cli/templates/webcomponents/igc-ts/projects/_base/files/__dot__github/workflows/github-pages.yml
@@ -8,14 +8,17 @@ on:
 
 jobs:
   build-and-deploy:
-    # Deactivate the workflow. Will be changed when AB is ready
-    if: false
+    if: $(yamlGenerateDeploymentScript) == true
     runs-on: ubuntu-latest
 
     permissions:
       pages: write
       id-token: write
 
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
     strategy:
       matrix:
         node-version: [22.x]
diff --git a/packages/cli/templates/webcomponents/igc-ts/projects/_base/index.ts b/packages/cli/templates/webcomponents/igc-ts/projects/_base/index.ts
@@ -37,7 +37,8 @@ export class BaseIgcProject implements ProjectTemplate {
 			dot: ".",
 			path: name,
 			projectTemplate: this.id,
-			yamlDefaultBranch: this.id === "base" ? "<%=yaml-default-branch%>" : "main"
+			yamlDefaultBranch: this.id === "base" ? "<%=yaml-default-branch%>" : "main",
+			yamlGenerateDeploymentScript: "<%=yaml-generate-deployment-script%>"
 		};
 
 		return config;
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@igniteui/cli-core",
-  "version": "14.2.3",
+  "version": "14.2.4-beta.0",
   "description": "Base types and functionality for Ignite UI CLI",
   "repository": {
     "type": "git",
diff --git a/packages/core/update/Update.ts b/packages/core/update/Update.ts
@@ -198,7 +198,7 @@ function updatePackageJsonFiles(
 function updateWorkflows(
 	fs: IFileSystem
 ): void {
-	const workflowFiles = ["node.js.yml", "github.io.yml"];
+	const workflowFiles = ["node.js.yml", "github-pages.yml"];
 	const oldNpmInstall = "- run: npm i # replace with 'npm ci' after committing lock file from first install";
 	const newNpmInstall =
 `- run: echo "@infragistics:registry=https://packages.infragistics.com/npm/js-licensed/" >> ~/.npmrc
diff --git a/packages/igx-templates/igx-ts-legacy/projects/_base/files/__dot__github/workflows/github-pages.yml b/packages/igx-templates/igx-ts-legacy/projects/_base/files/__dot__github/workflows/github-pages.yml
@@ -8,14 +8,17 @@ on:
 
 jobs:
   build-and-deploy:
-    # Deactivate the workflow. Will be changed when AB is ready
-    if: false
+    if: <%=yamlGenerateDeploymentScript%> == true
     runs-on: ubuntu-latest
 
     permissions:
       pages: write
       id-token: write
 
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
     strategy:
       matrix:
         node-version: [22.x]
diff --git a/packages/igx-templates/igx-ts-legacy/projects/_base/index.ts b/packages/igx-templates/igx-ts-legacy/projects/_base/index.ts
@@ -66,7 +66,8 @@ $app-palette: palette($primary, $secondary, $surface);
 			path: name,
 			projectTemplate: this.id,
 			yamlDefaultBranch: "<%=yaml-default-branch%>", // the placeholder will be evaluated by CodeGen
-			ApplicationTitle: "<%=ApplicationTitle%>" // the placeholder will be evaluated by CodeGen
+			ApplicationTitle: "<%=ApplicationTitle%>", // the placeholder will be evaluated by CodeGen
+			yamlGenerateDeploymentScript: "<%=yaml-generate-deployment-script%>" // the placeholder will be evaluated by CodeGen
 		};
 
 		switch (theme) {
diff --git a/packages/igx-templates/igx-ts-legacy/projects/_base_with_home/files/__dot__github/workflows/github-pages.yml b/packages/igx-templates/igx-ts-legacy/projects/_base_with_home/files/__dot__github/workflows/github-pages.yml
@@ -8,14 +8,17 @@ on:
 
 jobs:
   build-and-deploy:
-    # Deactivate the workflow. Will be changed when AB is ready
-    if: false
+    if: <%=yamlGenerateDeploymentScript%> == true
     runs-on: ubuntu-latest
 
     permissions:
       pages: write
       id-token: write
 
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
     strategy:
       matrix:
         node-version: [22.x]
diff --git a/packages/igx-templates/igx-ts/projects/_base/files/__dot__github/workflows/github-pages.yml b/packages/igx-templates/igx-ts/projects/_base/files/__dot__github/workflows/github-pages.yml
@@ -8,14 +8,17 @@ on:
 
 jobs:
   build-and-deploy:
-    # Deactivate the workflow. Will be changed when AB is ready
-    if: false
+    if: <%=yamlGenerateDeploymentScript%> == true
     runs-on: ubuntu-latest
 
     permissions:
       pages: write
       id-token: write
 
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
     strategy:
       matrix:
         node-version: [22.x]
diff --git a/packages/igx-templates/igx-ts/projects/_base/index.ts b/packages/igx-templates/igx-ts/projects/_base/index.ts
@@ -67,7 +67,8 @@ $app-palette: palette($primary, $secondary, $surface);
 			projectTemplate: this.id,
 			igxPackage: NPM_ANGULAR,
 			yamlDefaultBranch: "<%=yaml-default-branch%>", // the placeholder will be evaluated by CodeGen
-			ApplicationTitle: "<%=ApplicationTitle%>" // the placeholder will be evaluated by CodeGen
+			ApplicationTitle: "<%=ApplicationTitle%>", // the placeholder will be evaluated by CodeGen
+			yamlGenerateDeploymentScript: "<%=yaml-generate-deployment-script%>" // the placeholder will be evaluated by CodeGen
 		};
 
 		switch (theme) {
diff --git a/packages/igx-templates/igx-ts/projects/_base_with_home/files/__dot__github/workflows/github-pages.yml b/packages/igx-templates/igx-ts/projects/_base_with_home/files/__dot__github/workflows/github-pages.yml
@@ -8,14 +8,17 @@ on:
 
 jobs:
   build-and-deploy:
-    # Deactivate the workflow. Will be changed when AB is ready
-    if: false
+    if: <%=yamlGenerateDeploymentScript%> == true
     runs-on: ubuntu-latest
 
     permissions:
       pages: write
       id-token: write
 
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
     strategy:
       matrix:
         node-version: [22.x]
diff --git a/packages/igx-templates/package.json b/packages/igx-templates/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@igniteui/angular-templates",
-  "version": "18.2.1423",
+  "version": "18.2.1424-beta.0",
   "description": "Templates for Ignite UI for Angular projects and components",
   "repository": {
     "type": "git",
@@ -12,7 +12,7 @@
   "author": "Infragistics",
   "license": "MIT",
   "dependencies": {
-    "@igniteui/cli-core": "~14.2.3",
+    "@igniteui/cli-core": "~14.2.4-beta.0",
     "typescript": "~5.5.4"
   }
 }
diff --git a/packages/ng-schematics/package.json b/packages/ng-schematics/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@igniteui/angular-schematics",
-  "version": "18.2.1423",
+  "version": "18.2.1424-beta.0",
   "description": "Ignite UI for Angular Schematics for ng new and ng generate",
   "repository": {
     "type": "git",
@@ -20,8 +20,8 @@
   "dependencies": {
     "@angular-devkit/core": "^18.2.4",
     "@angular-devkit/schematics": "^18.2.4",
-    "@igniteui/angular-templates": "~18.2.1423",
-    "@igniteui/cli-core": "~14.2.3",
+    "@igniteui/angular-templates": "~18.2.1424-beta.0",
+    "@igniteui/cli-core": "~14.2.4-beta.0",
     "@schematics/angular": "~14.0.0",
     "rxjs": "^7.8.1"
   },
diff --git a/spec/unit/update-spec.ts b/spec/unit/update-spec.ts
@@ -295,7 +295,7 @@ title = 'igniteui-angular example';
 # end content
 `},
 {
-				path: ".github/workflows/github.io.yml",
+				path: ".github/workflows/github-pages.yml",
 				content:
 `# start content
     - run: npm i # replace with 'npm ci' after committing lock file from first install
@@ -596,7 +596,7 @@ export default function Home() {
 # end content
 `},
 {
-				path: ".github/workflows/github.io.yml",
+				path: ".github/workflows/github-pages.yml",
 				content:
 `# start content
     - run: npm i # replace with 'npm ci' after committing lock file from first install
@@ -890,7 +890,7 @@ export default class App extends LitElement {
 # end content
 `},
 {
-				path: ".github/workflows/github.io.yml",
+				path: ".github/workflows/github-pages.yml",
 				content:
 `# start content
     - run: npm i # replace with 'npm ci' after committing lock file from first install

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,8 @@ export class BaseIgrTsProject implements ProjectTemplate {`
`42`	`42`	`"dot": ".",`
`43`	`43`	`"path": name,`
`44`	`44`	`"projectTemplate": this.id,`
`45`		`- "yamlDefaultBranch": this.id === "base" ? "<%=yaml-default-branch%>" : "main"`
	`45`	`+ "yamlDefaultBranch": this.id === "base" ? "<%=yaml-default-branch%>" : "main",`
	`46`	`+ "yamlGenerateDeploymentScript": "<%=yaml-generate-deployment-script%>"`
`46`	`47`	`};`
`47`	`48`	`}`
`48`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@igniteui/cli-core",`
`3`		`- "version": "14.2.3",`
	`3`	`+ "version": "14.2.4-beta.0",`
`4`	`4`	`"description": "Base types and functionality for Ignite UI CLI",`
`5`	`5`	`"repository": {`
`6`	`6`	`"type": "git",`