Merge pull request #1 from VerticeOne/feature/CE-480_template_repo

Include repo object when templating

Author: kristian-lesko

README.md

@@ -234,6 +234,37 @@ Result:
 Created by Maxi (@BetaHuhn)
 ```
 
+By default, every Nunjucks template context will be pre-populated with the `repo` object containing the following values:
+
+- `repo.url`
+- `repo.fullName`
+- `repo.uniqueName`
+- `repo.host`
+- `repo.user`
+- `repo.name`
+- `repo.branch`
+
+This can be useful for certain bulk templating use cases:
+
+```yml
+# sync.yml
+
+group:
+  - repos: |
+      user/repo1
+      user/repo2
+      ...
+    files:
+      - source: src/README.md
+        template: true
+```
+
+```yml
+# README.md
+
+Hello from {{ repo.name }} by {{ repo.user }}!
+```
+
 You can also use `extends` with a relative path to inherit other templates. Take a look at Nunjucks [template syntax](https://mozilla.github.io/nunjucks/templating.html) for more info.
 
 ```yml

dist/index.js

@@ -161,6 +161,7 @@ const parseRepoName = (fullRepo) => {
 	const branch = fullRepo.split('@')[1] || 'default'
 
 	return {
+		url: `https://${ host }/${ user }/${ name }`,
 		fullName: `${ host }/${ user }/${ name }`,
 		uniqueName: `${ host }/${ user }/${ name }@${ branch }`,
 		host,
@@ -248,4 +249,4 @@ export async function parseConfig() {
 	return Object.values(result)
 }
 
-export default context
+export default context

src/config.js

@@ -123,7 +123,7 @@ export default class Git {
 
 	async getBaseBranch() {
 		this.baseBranch = await execCmd(
-			`git rev-parse --abbrev-ref HEAD`,
+			`git branch --show-current`,
 			this.workingDir
 		)
 	}
@@ -209,7 +209,7 @@ export default class Git {
 
 	async getLastCommitSha() {
 		this.lastCommitSha = await execCmd(
-			`git rev-parse HEAD`,
+			`git log -1 --format='%H'`,
 			this.workingDir
 		)
 	}
@@ -527,4 +527,4 @@ export default class Git {
 		})
 		this.lastCommitSha = request.data.sha
 	}
-}
+}

src/git.js

@@ -69,15 +69,19 @@ export async function pathIsDirectory(path) {
 	return stat.isDirectory()
 }
 
-export async function write(src, dest, context) {
+export async function write(src, dest, context, item) {
 	if (typeof context !== 'object') {
 		context = {}
 	}
+
+	// include current repo constants (e.g., host, user, name, branch, etc.)
+	context.repo = item.repo
+
 	const content = nunjucks.render(src, context)
 	await fs.outputFile(dest, content)
 }
 
-export async function copy(src, dest, isDirectory, file) {
+export async function copy(src, dest, isDirectory, file, item) {
 	const deleteOrphaned = isDirectory && file.deleteOrphaned
 	const exclude = file.exclude
 
@@ -121,12 +125,12 @@ export async function copy(src, dest, isDirectory, file) {
 
 				const srcPath = path.join(src, srcFile)
 				const destPath = path.join(dest, srcFile)
-				await write(srcPath, destPath, file.template)
+				await write(srcPath, destPath, file.template, item)
 			}
 		} else {
 			core.debug(`Render file ${ src } to ${ dest }`)
 
-			await write(src, dest, file.template)
+			await write(src, dest, file.template, item)
 		}
 	} else {
 		core.debug(`Copy ${ src } to ${ dest }`)
@@ -166,4 +170,4 @@ export async function remove(src) {
 
 export function arrayEquals(array1, array2) {
 	return Array.isArray(array1) && Array.isArray(array2) && array1.length === array2.length && array1.every((value, i) => value === array2[i])
-}
+}

src/helpers.js

@@ -33,10 +33,10 @@ async function run() {
 
 	await forEach(repos, async (item) => {
 		core.info(`Repository Info`)
-		core.info(`Slug		: ${ item.repo.name }`)
-		core.info(`Owner		: ${ item.repo.user }`)
-		core.info(`Https Url	: https://${ item.repo.fullName }`)
-		core.info(`Branch		: ${ item.repo.branch }`)
+		core.info(`Slug   : ${ item.repo.name }`)
+		core.info(`Owner  : ${ item.repo.user }`)
+		core.info(`Url    : ${ item.repo.url }`)
+		core.info(`Branch : ${ item.repo.branch }`)
 		core.info('	')
 		try {
 
@@ -74,7 +74,7 @@ async function run() {
 
 				if (isDirectory) core.info(`Source is directory`)
 
-				await copy(source, dest, isDirectory, file)
+				await copy(source, dest, isDirectory, file, item)
 
 				await git.add(file.dest)
 
@@ -220,4 +220,4 @@ run()
 	.catch((err) => {
 		core.setFailed(err.message)
 		core.debug(err)
-	})
+	})