Skip to content

Commit faadbbf

Browse files
committed
Add company parameter
1 parent 84247f0 commit faadbbf

10 files changed

+26
-24
lines changed

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
We use fairly "standard" github contribution workflow:
44

5-
1. Make an [Issue](https://github.com/3d-group/{{REPOSITORY_NAME}}/issues/new)
5+
1. Make an [Issue](https://github.com/{{COMPANY}}/{{REPOSITORY_NAME}}/issues/new)
66
2. Fork this repository (For further details, see https://docs.github.com/en/github/getting-started-with-github/fork-a-repo)
77
3. Develop changes to a new branch to your forked repository
88
4. Create a Pull Request from your forked repository against this repository
@@ -23,7 +23,7 @@ Open `Packages/manifest.json` with your favorite text editor. Add following line
2323
```json
2424
{
2525
"dependencies": {
26-
"com.3d-group.{{REPOSITORY_NAME}}": "https://github.com/YOUR_USER/{{REPOSITORY_NAME}}.git"
26+
"com.{{COMPANY}}.{{REPOSITORY_NAME}}": "https://github.com/YOUR_USER/{{REPOSITORY_NAME}}.git"
2727
}
2828
}
2929
```

Editor/Unity.com.3d-group.{{REPOSITORY_NAME}}.Editor.asmdef Editor/Unity.com.{{COMPANY}}.{{REPOSITORY_NAME}}.Editor.asmdef

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "Unity.com.3d-group.{{REPOSITORY_NAME}}.Editor",
2+
"name": "Unity.com.{{COMPANY}}.{{REPOSITORY_NAME}}.Editor",
33
"references": [
44
"GUID:{{GUID}}"
55
],

RUNME.sh

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
#!/bin/bash
22

3+
read -p "Enter company name (eg. 3d-group): " COMPANY
4+
read -p "Enter company friendly name (eg. 3D Group): " COMPANY_FRIENDLY_NAME
35
read -p "Enter repository name (eg. unity-simple-notifications): " REPOSITORY_NAME
46
read -p "Enter friendly name (eg. Notifications): " FRIENDLY_NAME
57
read -p "Enter description (eg. Simple UI notifications for Unity game engine.): " DESCRIPTION
@@ -11,7 +13,7 @@ echo 'Replacing template strings...'
1113
for file in **; do
1214
if [[ -f $file ]] && [[ -w $file ]] && [[ $file != 'RUNME.sh' ]] && [[ $file != Samples/** ]] && [[ $file != .git/** ]]; then
1315
echo "Altering file ${file}"
14-
replace="s/{{REPOSITORY_NAME}}/"${REPOSITORY_NAME}"/g;s/{{FRIENDLY_NAME}}/"${FRIENDLY_NAME}"/g;s/{{DESCRIPTION}}/"${DESCRIPTION}"/g;s/{{UNITY_VERSION}}/"${UNITY_VERSION}"/g"
16+
replace="s/{{REPOSITORY_NAME}}/"${REPOSITORY_NAME}"/g;s/{{FRIENDLY_NAME}}/"${FRIENDLY_NAME}"/g;s/{{DESCRIPTION}}/"${DESCRIPTION}"/g;s/{{UNITY_VERSION}}/"${UNITY_VERSION}"/g;s/{{COMPANY}}/"${COMPANY}"/g;s/{{COMPANY_FRIENDLY_NAME}}/"${COMPANY_FRIENDLY_NAME}"/g"
1517

1618
# Replace template strings inside files
1719
sed -i -- $replace "$file"

Runtime/Unity.com.3d-group.{{REPOSITORY_NAME}}.asmdef Runtime/Unity.com.{{COMPANY}}.{{REPOSITORY_NAME}}.asmdef

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "Unity.com.3d-group.{{REPOSITORY_NAME}}",
2+
"name": "Unity.com.{{COMPANY}}.{{REPOSITORY_NAME}}",
33
"references": [],
44
"includePlatforms": [],
55
"excludePlatforms": [],

Tests/Editor/Unity.com.3d-group.{{REPOSITORY_NAME}}.EditorTests.asmdef Tests/Editor/Unity.com.{{COMPANY}}.{{REPOSITORY_NAME}}.EditorTests.asmdef

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "Unity.com.3d-group.{{REPOSITORY_NAME}}.Editor.Tests",
2+
"name": "Unity.com.{{COMPANY}}.{{REPOSITORY_NAME}}.Editor.Tests",
33
"references": [
4-
"Unity.com.3d-group.{{REPOSITORY_NAME}}"
4+
"Unity.com.{{COMPANY}}.{{REPOSITORY_NAME}}"
55
],
66
"optionalUnityReferences": [
77
"TestAssemblies"

Tests/Runtime/Unity.com.3d-group.{{REPOSITORY_NAME}}.Tests.asmdef Tests/Runtime/Unity.com.{{COMPANY}}.{{REPOSITORY_NAME}}.Tests.asmdef

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "Unity.com.3d-group.{{REPOSITORY_NAME}}.Tests",
2+
"name": "Unity.com.{{COMPANY}}.{{REPOSITORY_NAME}}.Tests",
33
"references": [
4-
"Unity.com.3d-group.{{REPOSITORY_NAME}}"
4+
"Unity.com.{{COMPANY}}.{{REPOSITORY_NAME}}"
55
],
66
"optionalUnityReferences": [
77
"TestAssemblies"

example-.github/CODEOWNERS

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
# These owners will be the default owners for everything in the repo. Unless a later match takes precedence.
44
# Owners will be requested for review when someone opens a pull request.
5-
* @3d-group/Games
5+
* @{{COMPANY}}/Games

example-README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
[![npm package](https://img.shields.io/npm/v/com.3d-group.{{REPOSITORY_NAME}})](https://www.npmjs.com/package/com.3d-group.{{REPOSITORY_NAME}})
2-
[![openupm](https://img.shields.io/npm/v/com.3d-group.{{REPOSITORY_NAME}}?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.3d-group.{{REPOSITORY_NAME}}/)
3-
![Tests](https://github.com/3d-group/{{REPOSITORY_NAME}}/workflows/Tests/badge.svg)
1+
[![npm package](https://img.shields.io/npm/v/com.{{COMPANY}}.{{REPOSITORY_NAME}})](https://www.npmjs.com/package/com.{{COMPANY}}.{{REPOSITORY_NAME}})
2+
[![openupm](https://img.shields.io/npm/v/com.{{COMPANY}}.{{REPOSITORY_NAME}}?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.{{COMPANY}}.{{REPOSITORY_NAME}}/)
3+
![Tests](https://github.com/{{COMPANY}}/{{REPOSITORY_NAME}}/workflows/Tests/badge.svg)
44
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
55

66
# {{FRIENDLY_NAME}}
@@ -31,23 +31,23 @@ Open `Packages/manifest.json` with your favorite text editor. Add a [scoped regi
3131
"name": "npmjs",
3232
"url": "https://registry.npmjs.org/",
3333
"scopes": [
34-
"com.3d-group"
34+
"com.{{COMPANY}}"
3535
]
3636
}
3737
],
3838
"dependencies": {
39-
"com.3d-group.{{REPOSITORY_NAME}}": "1.0.0"
39+
"com.{{COMPANY}}.{{REPOSITORY_NAME}}": "1.0.0"
4040
}
4141
}
4242
```
4343
Package should now appear in package manager.
4444

4545
### via OpenUPM
4646

47-
The package is also available on the [openupm registry](https://openupm.com/packages/com.3d-group.{{REPOSITORY_NAME}}). You can install it eg. via [openupm-cli](https://github.com/openupm/openupm-cli).
47+
The package is also available on the [openupm registry](https://openupm.com/packages/com.{{COMPANY}}.{{REPOSITORY_NAME}}). You can install it eg. via [openupm-cli](https://github.com/openupm/openupm-cli).
4848

4949
```
50-
openupm add com.3d-group.{{REPOSITORY_NAME}}
50+
openupm add com.{{COMPANY}}.{{REPOSITORY_NAME}}
5151
```
5252

5353
### via Git URL
@@ -56,7 +56,7 @@ Open `Packages/manifest.json` with your favorite text editor. Add following line
5656
```json
5757
{
5858
"dependencies": {
59-
"com.3d-group.{{REPOSITORY_NAME}}": "https://github.com/3d-group/{{REPOSITORY_NAME}}.git"
59+
"com.{{COMPANY}}.{{REPOSITORY_NAME}}": "https://github.com/{{COMPANY}}/{{REPOSITORY_NAME}}.git"
6060
}
6161
}
6262
```
@@ -71,7 +71,7 @@ Open `Packages/manifest.json` with your favorite text editor. Add following line
7171
{
7272
"dependencies": {
7373
},
74-
"testables": [ "com.3d-group.{{REPOSITORY_NAME}}" ]
74+
"testables": [ "com.{{COMPANY}}.{{REPOSITORY_NAME}}" ]
7575
}
7676
```
7777

package.json

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "com.3d-group.{{REPOSITORY_NAME}}",
2+
"name": "com.{{COMPANY}}.{{REPOSITORY_NAME}}",
33
"displayName": "3D Group - {{FRIENDLY_NAME}}",
44
"version": "0.0.0",
55
"unity": "2019.4",
@@ -8,16 +8,16 @@
88
"unity",
99
"unity3d",
1010
"upm",
11-
"3d-group",
11+
"{{COMPANY}}",
1212
"utility"
1313
],
14-
"homepage": "https://github.com/3d-group/{{REPOSITORY_NAME}}.git",
14+
"homepage": "https://github.com/{{COMPANY}}/{{REPOSITORY_NAME}}.git",
1515
"bugs": {
16-
"url": "https://github.com/3d-group/{{REPOSITORY_NAME}}/issues"
16+
"url": "https://github.com/{{COMPANY}}/{{REPOSITORY_NAME}}/issues"
1717
},
1818
"repository": {
1919
"type": "git",
20-
"url": "git+ssh://[email protected]/3d-group/{{REPOSITORY_NAME}}.git"
20+
"url": "git+ssh://[email protected]/{{COMPANY}}/{{REPOSITORY_NAME}}.git"
2121
},
2222
"license": "MIT",
2323
"author": "3D Group (https://3d.fi/)",

0 commit comments

Comments
 (0)