diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 000000000..cf2bb0aab --- /dev/null +++ b/.editorconfig @@ -0,0 +1,7 @@ +root = true + +[*.cs] +indent_style = space +indent_size = 4 +insert_final_newline = true +trim_trailing_whitespace = true diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 3d2be8475..c17e1dc1c 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -9,7 +9,8 @@ Have you read GitHub for Unity's Code of Conduct? By filing an Issue, you are ex - Be sure to run with tracing enabled to capture runtime details in the log file - Include the log file in the PR. - On Windows, the extension log file is at `%LOCALAPPDATA%\GitHubUnity\github-unity.log` - - On macOS, the extension log file is at `~/Library/Application Support/GitHubUnity/github-unity.log` + - On macOS, the extension log file is at `~/Library/Logs/GitHubUnity/github-unity.log` + - On linux, the extension log file is at `~/.local/share/GitHubUnity/github-unity.log` ### Description diff --git a/.gitignore b/.gitignore index bcd8c5dcd..7fc38bf13 100644 --- a/.gitignore +++ b/.gitignore @@ -1,9 +1,11 @@ .vs/ .idea/ +.vscode/ packages/ _NCrunch_GitHub.Unity *.user .DS_Store build/ TestResult.xml -submodules/ \ No newline at end of file +*.stackdump +*.lastcodeanalysissucceeded \ No newline at end of file diff --git a/.gitmodules b/.gitmodules index d9e14a3e9..8ecda521f 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,6 @@ [submodule "script"] path = script url = git@github.com:github-for-unity/UnityBuildScripts +[submodule "submodules/packaging"] + path = submodules/packaging + url = https://github.com/github-for-unity/packaging diff --git a/GitHub.Unity.OctokitDebugging.sln b/GitHub.Unity.OctokitDebugging.sln deleted file mode 100644 index 8d9cef6c2..000000000 --- a/GitHub.Unity.OctokitDebugging.sln +++ /dev/null @@ -1,132 +0,0 @@ - -Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio 14 -VisualStudioVersion = 14.0.25420.1 -MinimumVisualStudioVersion = 10.0.40219.1 -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GitHub.Unity", "src\UnityExtension\Assets\Editor\GitHub.Unity\GitHub.Unity.csproj", "{ADD7A18B-DD2A-4C22-A2C1-488964EFF30A}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GitHub.Api", "src\GitHub.Api\GitHub.Api.csproj", "{B389ADAF-62CC-486E-85B4-2D8B078DF763}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GitHub.Logging", "src\GitHub.Logging\GitHub.Logging.csproj", "{BB6A8EDA-15D8-471B-A6ED-EE551E0B3BA0}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CopyLibrariesToDevelopmentFolder", "src\packaging\CopyLibrariesToDevelopmentFolder\CopyLibrariesToDevelopmentFolder.csproj", "{44257C81-EE4A-4817-9AF4-A26C02AA6DD4}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "UnitTests", "src\tests\UnitTests\UnitTests.csproj", "{69F13D9D-AD56-4EEC-AE10-D528EE23E1A9}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "IntegrationTests", "src\tests\IntegrationTests\IntegrationTests.csproj", "{1AC3F82E-AEAE-4C84-825C-207BB264FCFA}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Tests", "Tests", "{D17F1B4C-42DC-4E78-BCEF-9F239A084C4D}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "packaging", "packaging", "{B50B646C-3B86-4BDA-9F2B-766F96608CE0}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CopyLibrariesToPackageProject", "src\packaging\CopyLibrariesToPackageProject\CopyLibrariesToPackageProject.csproj", "{7DEF4226-7740-457F-9199-34174C49A978}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestUtils", "src\tests\TestUtils\TestUtils.csproj", "{66A1D219-F61D-4AE4-9BD7-AAEB97276FFF}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TaskSystem", "src\tests\TaskSystemIntegrationTests\TaskSystem.csproj", "{1A382F40-FD9E-43E1-89C1-320073F35CE9}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestApp", "src\tests\TestApp\TestApp.csproj", "{08B87D2A-8CF1-4211-B7AA-5209F00F72F8}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "dotnet-httpclient35", "dotnet-httpclient35", "{C6854BB9-D594-46B0-9E10-72607CC97E77}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "octokit", "octokit", "{5C9C1D3B-0740-4EF3-A374-CCCD67FB6E48}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Octokit-35", "..\octokit.net\Octokit\Octokit-35.csproj", "{49EF16A2-5ED1-480F-80A1-D1D05D6C1BE4}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "System.Net.Http-net_3_5", "..\dotnet-httpclient35\System.Net.Http\System.Net.Http-net_3_5.csproj", "{9862694D-E4FA-418B-8692-A0280FEDDF36}" -EndProject -Global - GlobalSection(SolutionConfigurationPlatforms) = preSolution - Debug|Any CPU = Debug|Any CPU - dev|Any CPU = dev|Any CPU - Release|Any CPU = Release|Any CPU - EndGlobalSection - GlobalSection(ProjectConfigurationPlatforms) = postSolution - {ADD7A18B-DD2A-4C22-A2C1-488964EFF30A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {ADD7A18B-DD2A-4C22-A2C1-488964EFF30A}.Debug|Any CPU.Build.0 = Debug|Any CPU - {ADD7A18B-DD2A-4C22-A2C1-488964EFF30A}.dev|Any CPU.ActiveCfg = dev|Any CPU - {ADD7A18B-DD2A-4C22-A2C1-488964EFF30A}.dev|Any CPU.Build.0 = dev|Any CPU - {ADD7A18B-DD2A-4C22-A2C1-488964EFF30A}.Release|Any CPU.ActiveCfg = Release|Any CPU - {ADD7A18B-DD2A-4C22-A2C1-488964EFF30A}.Release|Any CPU.Build.0 = Release|Any CPU - {B389ADAF-62CC-486E-85B4-2D8B078DF763}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {B389ADAF-62CC-486E-85B4-2D8B078DF763}.Debug|Any CPU.Build.0 = Debug|Any CPU - {B389ADAF-62CC-486E-85B4-2D8B078DF763}.dev|Any CPU.ActiveCfg = dev|Any CPU - {B389ADAF-62CC-486E-85B4-2D8B078DF763}.dev|Any CPU.Build.0 = dev|Any CPU - {B389ADAF-62CC-486E-85B4-2D8B078DF763}.Release|Any CPU.ActiveCfg = Release|Any CPU - {B389ADAF-62CC-486E-85B4-2D8B078DF763}.Release|Any CPU.Build.0 = Release|Any CPU - {BB6A8EDA-15D8-471B-A6ED-EE551E0B3BA0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {BB6A8EDA-15D8-471B-A6ED-EE551E0B3BA0}.Debug|Any CPU.Build.0 = Debug|Any CPU - {BB6A8EDA-15D8-471B-A6ED-EE551E0B3BA0}.dev|Any CPU.ActiveCfg = dev|Any CPU - {BB6A8EDA-15D8-471B-A6ED-EE551E0B3BA0}.dev|Any CPU.Build.0 = dev|Any CPU - {BB6A8EDA-15D8-471B-A6ED-EE551E0B3BA0}.Release|Any CPU.ActiveCfg = Release|Any CPU - {BB6A8EDA-15D8-471B-A6ED-EE551E0B3BA0}.Release|Any CPU.Build.0 = Release|Any CPU - {44257C81-EE4A-4817-9AF4-A26C02AA6DD4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {44257C81-EE4A-4817-9AF4-A26C02AA6DD4}.Debug|Any CPU.Build.0 = Debug|Any CPU - {44257C81-EE4A-4817-9AF4-A26C02AA6DD4}.dev|Any CPU.ActiveCfg = Debug|Any CPU - {44257C81-EE4A-4817-9AF4-A26C02AA6DD4}.dev|Any CPU.Build.0 = Debug|Any CPU - {44257C81-EE4A-4817-9AF4-A26C02AA6DD4}.Release|Any CPU.ActiveCfg = Release|Any CPU - {44257C81-EE4A-4817-9AF4-A26C02AA6DD4}.Release|Any CPU.Build.0 = Release|Any CPU - {69F13D9D-AD56-4EEC-AE10-D528EE23E1A9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {69F13D9D-AD56-4EEC-AE10-D528EE23E1A9}.Debug|Any CPU.Build.0 = Debug|Any CPU - {69F13D9D-AD56-4EEC-AE10-D528EE23E1A9}.dev|Any CPU.ActiveCfg = Debug|Any CPU - {69F13D9D-AD56-4EEC-AE10-D528EE23E1A9}.dev|Any CPU.Build.0 = Debug|Any CPU - {69F13D9D-AD56-4EEC-AE10-D528EE23E1A9}.Release|Any CPU.ActiveCfg = Release|Any CPU - {69F13D9D-AD56-4EEC-AE10-D528EE23E1A9}.Release|Any CPU.Build.0 = Release|Any CPU - {1AC3F82E-AEAE-4C84-825C-207BB264FCFA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {1AC3F82E-AEAE-4C84-825C-207BB264FCFA}.Debug|Any CPU.Build.0 = Debug|Any CPU - {1AC3F82E-AEAE-4C84-825C-207BB264FCFA}.dev|Any CPU.ActiveCfg = Debug|Any CPU - {1AC3F82E-AEAE-4C84-825C-207BB264FCFA}.dev|Any CPU.Build.0 = Debug|Any CPU - {1AC3F82E-AEAE-4C84-825C-207BB264FCFA}.Release|Any CPU.ActiveCfg = Release|Any CPU - {1AC3F82E-AEAE-4C84-825C-207BB264FCFA}.Release|Any CPU.Build.0 = Release|Any CPU - {7DEF4226-7740-457F-9199-34174C49A978}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {7DEF4226-7740-457F-9199-34174C49A978}.Debug|Any CPU.Build.0 = Debug|Any CPU - {7DEF4226-7740-457F-9199-34174C49A978}.dev|Any CPU.ActiveCfg = Debug|Any CPU - {7DEF4226-7740-457F-9199-34174C49A978}.dev|Any CPU.Build.0 = Debug|Any CPU - {7DEF4226-7740-457F-9199-34174C49A978}.Release|Any CPU.ActiveCfg = Release|Any CPU - {7DEF4226-7740-457F-9199-34174C49A978}.Release|Any CPU.Build.0 = Release|Any CPU - {66A1D219-F61D-4AE4-9BD7-AAEB97276FFF}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {66A1D219-F61D-4AE4-9BD7-AAEB97276FFF}.Debug|Any CPU.Build.0 = Debug|Any CPU - {66A1D219-F61D-4AE4-9BD7-AAEB97276FFF}.dev|Any CPU.ActiveCfg = Debug|Any CPU - {66A1D219-F61D-4AE4-9BD7-AAEB97276FFF}.dev|Any CPU.Build.0 = Debug|Any CPU - {66A1D219-F61D-4AE4-9BD7-AAEB97276FFF}.Release|Any CPU.ActiveCfg = Release|Any CPU - {66A1D219-F61D-4AE4-9BD7-AAEB97276FFF}.Release|Any CPU.Build.0 = Release|Any CPU - {1A382F40-FD9E-43E1-89C1-320073F35CE9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {1A382F40-FD9E-43E1-89C1-320073F35CE9}.Debug|Any CPU.Build.0 = Debug|Any CPU - {1A382F40-FD9E-43E1-89C1-320073F35CE9}.dev|Any CPU.ActiveCfg = Debug|Any CPU - {1A382F40-FD9E-43E1-89C1-320073F35CE9}.dev|Any CPU.Build.0 = Debug|Any CPU - {1A382F40-FD9E-43E1-89C1-320073F35CE9}.Release|Any CPU.ActiveCfg = Release|Any CPU - {1A382F40-FD9E-43E1-89C1-320073F35CE9}.Release|Any CPU.Build.0 = Release|Any CPU - {08B87D2A-8CF1-4211-B7AA-5209F00F72F8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {08B87D2A-8CF1-4211-B7AA-5209F00F72F8}.Debug|Any CPU.Build.0 = Debug|Any CPU - {08B87D2A-8CF1-4211-B7AA-5209F00F72F8}.dev|Any CPU.ActiveCfg = Debug|Any CPU - {08B87D2A-8CF1-4211-B7AA-5209F00F72F8}.dev|Any CPU.Build.0 = Debug|Any CPU - {08B87D2A-8CF1-4211-B7AA-5209F00F72F8}.Release|Any CPU.ActiveCfg = Release|Any CPU - {08B87D2A-8CF1-4211-B7AA-5209F00F72F8}.Release|Any CPU.Build.0 = Release|Any CPU - {49EF16A2-5ED1-480F-80A1-D1D05D6C1BE4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {49EF16A2-5ED1-480F-80A1-D1D05D6C1BE4}.Debug|Any CPU.Build.0 = Debug|Any CPU - {49EF16A2-5ED1-480F-80A1-D1D05D6C1BE4}.dev|Any CPU.ActiveCfg = Debug|Any CPU - {49EF16A2-5ED1-480F-80A1-D1D05D6C1BE4}.dev|Any CPU.Build.0 = Debug|Any CPU - {49EF16A2-5ED1-480F-80A1-D1D05D6C1BE4}.Release|Any CPU.ActiveCfg = Release|Any CPU - {49EF16A2-5ED1-480F-80A1-D1D05D6C1BE4}.Release|Any CPU.Build.0 = Release|Any CPU - {9862694D-E4FA-418B-8692-A0280FEDDF36}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {9862694D-E4FA-418B-8692-A0280FEDDF36}.Debug|Any CPU.Build.0 = Debug|Any CPU - {9862694D-E4FA-418B-8692-A0280FEDDF36}.dev|Any CPU.ActiveCfg = Debug|Any CPU - {9862694D-E4FA-418B-8692-A0280FEDDF36}.dev|Any CPU.Build.0 = Debug|Any CPU - {9862694D-E4FA-418B-8692-A0280FEDDF36}.Release|Any CPU.ActiveCfg = Release|Any CPU - {9862694D-E4FA-418B-8692-A0280FEDDF36}.Release|Any CPU.Build.0 = Release|Any CPU - EndGlobalSection - GlobalSection(SolutionProperties) = preSolution - HideSolutionNode = FALSE - EndGlobalSection - GlobalSection(NestedProjects) = preSolution - {44257C81-EE4A-4817-9AF4-A26C02AA6DD4} = {B50B646C-3B86-4BDA-9F2B-766F96608CE0} - {69F13D9D-AD56-4EEC-AE10-D528EE23E1A9} = {D17F1B4C-42DC-4E78-BCEF-9F239A084C4D} - {1AC3F82E-AEAE-4C84-825C-207BB264FCFA} = {D17F1B4C-42DC-4E78-BCEF-9F239A084C4D} - {7DEF4226-7740-457F-9199-34174C49A978} = {B50B646C-3B86-4BDA-9F2B-766F96608CE0} - {66A1D219-F61D-4AE4-9BD7-AAEB97276FFF} = {D17F1B4C-42DC-4E78-BCEF-9F239A084C4D} - {1A382F40-FD9E-43E1-89C1-320073F35CE9} = {D17F1B4C-42DC-4E78-BCEF-9F239A084C4D} - {08B87D2A-8CF1-4211-B7AA-5209F00F72F8} = {D17F1B4C-42DC-4E78-BCEF-9F239A084C4D} - {49EF16A2-5ED1-480F-80A1-D1D05D6C1BE4} = {5C9C1D3B-0740-4EF3-A374-CCCD67FB6E48} - {9862694D-E4FA-418B-8692-A0280FEDDF36} = {C6854BB9-D594-46B0-9E10-72607CC97E77} - EndGlobalSection -EndGlobal diff --git a/GitHub.Unity.sln b/GitHub.Unity.sln index e5ce29f0a..0707a70fa 100644 --- a/GitHub.Unity.sln +++ b/GitHub.Unity.sln @@ -5,8 +5,12 @@ VisualStudioVersion = 14.0.25420.1 MinimumVisualStudioVersion = 10.0.40219.1 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GitHub.Unity", "src\UnityExtension\Assets\Editor\GitHub.Unity\GitHub.Unity.csproj", "{ADD7A18B-DD2A-4C22-A2C1-488964EFF30A}" EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GitHub.Unity.45", "src\UnityExtension\Assets\Editor\GitHub.Unity\GitHub.Unity.45.csproj", "{ADD7A18B-DD2A-4C22-A2C1-488964EFF30B}" +EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GitHub.Api", "src\GitHub.Api\GitHub.Api.csproj", "{B389ADAF-62CC-486E-85B4-2D8B078DF763}" EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GitHub.Api.45", "src\GitHub.Api\GitHub.Api.45.csproj", "{B389ADAF-62CC-486E-85B4-2D8B078DF76B}" +EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GitHub.Logging", "src\GitHub.Logging\GitHub.Logging.csproj", "{BB6A8EDA-15D8-471B-A6ED-EE551E0B3BA0}" EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CopyLibrariesToDevelopmentFolder", "src\packaging\CopyLibrariesToDevelopmentFolder\CopyLibrariesToDevelopmentFolder.csproj", "{44257C81-EE4A-4817-9AF4-A26C02AA6DD4}" @@ -25,75 +29,148 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestUtils", "src\tests\Test EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TaskSystem", "src\tests\TaskSystemIntegrationTests\TaskSystem.csproj", "{1A382F40-FD9E-43E1-89C1-320073F35CE9}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestApp", "src\tests\TestApp\TestApp.csproj", "{08B87D2A-8CF1-4211-B7AA-5209F00F72F8}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CommandLine", "src\tests\CommandLine\CommandLine.csproj", "{08B87D2A-8CF1-4211-B7AA-5209F00F72F8}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestWebServer", "src\tests\TestWebServer\TestWebServer.csproj", "{3DD3451C-30FA-4294-A3A9-1E080342F867}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "UnityTests", "src\UnityExtension\Assets\Editor\UnityTests\UnityTests.csproj", "{462CDBD4-0DDA-4854-1B13-CFDACBFB66F5}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ExtensionLoader", "src\UnityExtension\Assets\Editor\GitHub.Unity\ExtensionLoader\ExtensionLoader.csproj", "{6B0EAB30-511A-44C1-87FE-D9AB7E34D115}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "UnityShim", "src\UnityShim\UnityShim.csproj", "{F94F8AE1-C171-4A83-89E8-6557CA91A188}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU + DebugNoUnity|Any CPU = DebugNoUnity|Any CPU dev|Any CPU = dev|Any CPU Release|Any CPU = Release|Any CPU EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution {ADD7A18B-DD2A-4C22-A2C1-488964EFF30A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {ADD7A18B-DD2A-4C22-A2C1-488964EFF30A}.Debug|Any CPU.Build.0 = Debug|Any CPU + {ADD7A18B-DD2A-4C22-A2C1-488964EFF30A}.DebugNoUnity|Any CPU.ActiveCfg = Debug|Any CPU {ADD7A18B-DD2A-4C22-A2C1-488964EFF30A}.dev|Any CPU.ActiveCfg = dev|Any CPU {ADD7A18B-DD2A-4C22-A2C1-488964EFF30A}.dev|Any CPU.Build.0 = dev|Any CPU {ADD7A18B-DD2A-4C22-A2C1-488964EFF30A}.Release|Any CPU.ActiveCfg = Release|Any CPU {ADD7A18B-DD2A-4C22-A2C1-488964EFF30A}.Release|Any CPU.Build.0 = Release|Any CPU + {ADD7A18B-DD2A-4C22-A2C1-488964EFF30B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {ADD7A18B-DD2A-4C22-A2C1-488964EFF30B}.Debug|Any CPU.Build.0 = Debug|Any CPU + {ADD7A18B-DD2A-4C22-A2C1-488964EFF30B}.DebugNoUnity|Any CPU.ActiveCfg = Debug|Any CPU + {ADD7A18B-DD2A-4C22-A2C1-488964EFF30B}.dev|Any CPU.ActiveCfg = dev|Any CPU + {ADD7A18B-DD2A-4C22-A2C1-488964EFF30B}.dev|Any CPU.Build.0 = dev|Any CPU + {ADD7A18B-DD2A-4C22-A2C1-488964EFF30B}.Release|Any CPU.ActiveCfg = Release|Any CPU + {ADD7A18B-DD2A-4C22-A2C1-488964EFF30B}.Release|Any CPU.Build.0 = Release|Any CPU {B389ADAF-62CC-486E-85B4-2D8B078DF763}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {B389ADAF-62CC-486E-85B4-2D8B078DF763}.Debug|Any CPU.Build.0 = Debug|Any CPU + {B389ADAF-62CC-486E-85B4-2D8B078DF763}.DebugNoUnity|Any CPU.ActiveCfg = Debug|Any CPU + {B389ADAF-62CC-486E-85B4-2D8B078DF763}.DebugNoUnity|Any CPU.Build.0 = Debug|Any CPU {B389ADAF-62CC-486E-85B4-2D8B078DF763}.dev|Any CPU.ActiveCfg = dev|Any CPU {B389ADAF-62CC-486E-85B4-2D8B078DF763}.dev|Any CPU.Build.0 = dev|Any CPU {B389ADAF-62CC-486E-85B4-2D8B078DF763}.Release|Any CPU.ActiveCfg = Release|Any CPU {B389ADAF-62CC-486E-85B4-2D8B078DF763}.Release|Any CPU.Build.0 = Release|Any CPU + {B389ADAF-62CC-486E-85B4-2D8B078DF76B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {B389ADAF-62CC-486E-85B4-2D8B078DF76B}.Debug|Any CPU.Build.0 = Debug|Any CPU + {B389ADAF-62CC-486E-85B4-2D8B078DF76B}.DebugNoUnity|Any CPU.ActiveCfg = Debug|Any CPU + {B389ADAF-62CC-486E-85B4-2D8B078DF76B}.DebugNoUnity|Any CPU.Build.0 = Debug|Any CPU + {B389ADAF-62CC-486E-85B4-2D8B078DF76B}.dev|Any CPU.ActiveCfg = dev|Any CPU + {B389ADAF-62CC-486E-85B4-2D8B078DF76B}.dev|Any CPU.Build.0 = dev|Any CPU + {B389ADAF-62CC-486E-85B4-2D8B078DF76B}.Release|Any CPU.ActiveCfg = Release|Any CPU + {B389ADAF-62CC-486E-85B4-2D8B078DF76B}.Release|Any CPU.Build.0 = Release|Any CPU {BB6A8EDA-15D8-471B-A6ED-EE551E0B3BA0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {BB6A8EDA-15D8-471B-A6ED-EE551E0B3BA0}.Debug|Any CPU.Build.0 = Debug|Any CPU + {BB6A8EDA-15D8-471B-A6ED-EE551E0B3BA0}.DebugNoUnity|Any CPU.ActiveCfg = Debug|Any CPU + {BB6A8EDA-15D8-471B-A6ED-EE551E0B3BA0}.DebugNoUnity|Any CPU.Build.0 = Debug|Any CPU {BB6A8EDA-15D8-471B-A6ED-EE551E0B3BA0}.dev|Any CPU.ActiveCfg = dev|Any CPU {BB6A8EDA-15D8-471B-A6ED-EE551E0B3BA0}.dev|Any CPU.Build.0 = dev|Any CPU {BB6A8EDA-15D8-471B-A6ED-EE551E0B3BA0}.Release|Any CPU.ActiveCfg = Release|Any CPU {BB6A8EDA-15D8-471B-A6ED-EE551E0B3BA0}.Release|Any CPU.Build.0 = Release|Any CPU {44257C81-EE4A-4817-9AF4-A26C02AA6DD4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {44257C81-EE4A-4817-9AF4-A26C02AA6DD4}.Debug|Any CPU.Build.0 = Debug|Any CPU + {44257C81-EE4A-4817-9AF4-A26C02AA6DD4}.DebugNoUnity|Any CPU.ActiveCfg = Debug|Any CPU + {44257C81-EE4A-4817-9AF4-A26C02AA6DD4}.DebugNoUnity|Any CPU.Build.0 = Debug|Any CPU {44257C81-EE4A-4817-9AF4-A26C02AA6DD4}.dev|Any CPU.ActiveCfg = Debug|Any CPU {44257C81-EE4A-4817-9AF4-A26C02AA6DD4}.dev|Any CPU.Build.0 = Debug|Any CPU {44257C81-EE4A-4817-9AF4-A26C02AA6DD4}.Release|Any CPU.ActiveCfg = Release|Any CPU {44257C81-EE4A-4817-9AF4-A26C02AA6DD4}.Release|Any CPU.Build.0 = Release|Any CPU {69F13D9D-AD56-4EEC-AE10-D528EE23E1A9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {69F13D9D-AD56-4EEC-AE10-D528EE23E1A9}.Debug|Any CPU.Build.0 = Debug|Any CPU + {69F13D9D-AD56-4EEC-AE10-D528EE23E1A9}.DebugNoUnity|Any CPU.ActiveCfg = Debug|Any CPU + {69F13D9D-AD56-4EEC-AE10-D528EE23E1A9}.DebugNoUnity|Any CPU.Build.0 = Debug|Any CPU {69F13D9D-AD56-4EEC-AE10-D528EE23E1A9}.dev|Any CPU.ActiveCfg = Debug|Any CPU {69F13D9D-AD56-4EEC-AE10-D528EE23E1A9}.dev|Any CPU.Build.0 = Debug|Any CPU {69F13D9D-AD56-4EEC-AE10-D528EE23E1A9}.Release|Any CPU.ActiveCfg = Release|Any CPU {69F13D9D-AD56-4EEC-AE10-D528EE23E1A9}.Release|Any CPU.Build.0 = Release|Any CPU {1AC3F82E-AEAE-4C84-825C-207BB264FCFA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {1AC3F82E-AEAE-4C84-825C-207BB264FCFA}.Debug|Any CPU.Build.0 = Debug|Any CPU + {1AC3F82E-AEAE-4C84-825C-207BB264FCFA}.DebugNoUnity|Any CPU.ActiveCfg = Debug|Any CPU + {1AC3F82E-AEAE-4C84-825C-207BB264FCFA}.DebugNoUnity|Any CPU.Build.0 = Debug|Any CPU {1AC3F82E-AEAE-4C84-825C-207BB264FCFA}.dev|Any CPU.ActiveCfg = Debug|Any CPU {1AC3F82E-AEAE-4C84-825C-207BB264FCFA}.dev|Any CPU.Build.0 = Debug|Any CPU {1AC3F82E-AEAE-4C84-825C-207BB264FCFA}.Release|Any CPU.ActiveCfg = Release|Any CPU {1AC3F82E-AEAE-4C84-825C-207BB264FCFA}.Release|Any CPU.Build.0 = Release|Any CPU {7DEF4226-7740-457F-9199-34174C49A978}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {7DEF4226-7740-457F-9199-34174C49A978}.Debug|Any CPU.Build.0 = Debug|Any CPU + {7DEF4226-7740-457F-9199-34174C49A978}.DebugNoUnity|Any CPU.ActiveCfg = Debug|Any CPU {7DEF4226-7740-457F-9199-34174C49A978}.dev|Any CPU.ActiveCfg = Debug|Any CPU {7DEF4226-7740-457F-9199-34174C49A978}.dev|Any CPU.Build.0 = Debug|Any CPU {7DEF4226-7740-457F-9199-34174C49A978}.Release|Any CPU.ActiveCfg = Release|Any CPU {7DEF4226-7740-457F-9199-34174C49A978}.Release|Any CPU.Build.0 = Release|Any CPU {66A1D219-F61D-4AE4-9BD7-AAEB97276FFF}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {66A1D219-F61D-4AE4-9BD7-AAEB97276FFF}.Debug|Any CPU.Build.0 = Debug|Any CPU + {66A1D219-F61D-4AE4-9BD7-AAEB97276FFF}.DebugNoUnity|Any CPU.ActiveCfg = Debug|Any CPU + {66A1D219-F61D-4AE4-9BD7-AAEB97276FFF}.DebugNoUnity|Any CPU.Build.0 = Debug|Any CPU {66A1D219-F61D-4AE4-9BD7-AAEB97276FFF}.dev|Any CPU.ActiveCfg = Debug|Any CPU {66A1D219-F61D-4AE4-9BD7-AAEB97276FFF}.dev|Any CPU.Build.0 = Debug|Any CPU {66A1D219-F61D-4AE4-9BD7-AAEB97276FFF}.Release|Any CPU.ActiveCfg = Release|Any CPU {66A1D219-F61D-4AE4-9BD7-AAEB97276FFF}.Release|Any CPU.Build.0 = Release|Any CPU {1A382F40-FD9E-43E1-89C1-320073F35CE9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {1A382F40-FD9E-43E1-89C1-320073F35CE9}.Debug|Any CPU.Build.0 = Debug|Any CPU + {1A382F40-FD9E-43E1-89C1-320073F35CE9}.DebugNoUnity|Any CPU.ActiveCfg = Debug|Any CPU + {1A382F40-FD9E-43E1-89C1-320073F35CE9}.DebugNoUnity|Any CPU.Build.0 = Debug|Any CPU {1A382F40-FD9E-43E1-89C1-320073F35CE9}.dev|Any CPU.ActiveCfg = Debug|Any CPU {1A382F40-FD9E-43E1-89C1-320073F35CE9}.dev|Any CPU.Build.0 = Debug|Any CPU {1A382F40-FD9E-43E1-89C1-320073F35CE9}.Release|Any CPU.ActiveCfg = Release|Any CPU {1A382F40-FD9E-43E1-89C1-320073F35CE9}.Release|Any CPU.Build.0 = Release|Any CPU {08B87D2A-8CF1-4211-B7AA-5209F00F72F8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {08B87D2A-8CF1-4211-B7AA-5209F00F72F8}.Debug|Any CPU.Build.0 = Debug|Any CPU + {08B87D2A-8CF1-4211-B7AA-5209F00F72F8}.DebugNoUnity|Any CPU.ActiveCfg = Debug|Any CPU + {08B87D2A-8CF1-4211-B7AA-5209F00F72F8}.DebugNoUnity|Any CPU.Build.0 = Debug|Any CPU {08B87D2A-8CF1-4211-B7AA-5209F00F72F8}.dev|Any CPU.ActiveCfg = Debug|Any CPU {08B87D2A-8CF1-4211-B7AA-5209F00F72F8}.dev|Any CPU.Build.0 = Debug|Any CPU {08B87D2A-8CF1-4211-B7AA-5209F00F72F8}.Release|Any CPU.ActiveCfg = Release|Any CPU {08B87D2A-8CF1-4211-B7AA-5209F00F72F8}.Release|Any CPU.Build.0 = Release|Any CPU + {3DD3451C-30FA-4294-A3A9-1E080342F867}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {3DD3451C-30FA-4294-A3A9-1E080342F867}.Debug|Any CPU.Build.0 = Debug|Any CPU + {3DD3451C-30FA-4294-A3A9-1E080342F867}.DebugNoUnity|Any CPU.ActiveCfg = Debug|Any CPU + {3DD3451C-30FA-4294-A3A9-1E080342F867}.DebugNoUnity|Any CPU.Build.0 = Debug|Any CPU + {3DD3451C-30FA-4294-A3A9-1E080342F867}.dev|Any CPU.ActiveCfg = Debug|Any CPU + {3DD3451C-30FA-4294-A3A9-1E080342F867}.dev|Any CPU.Build.0 = Debug|Any CPU + {3DD3451C-30FA-4294-A3A9-1E080342F867}.Release|Any CPU.ActiveCfg = Release|Any CPU + {3DD3451C-30FA-4294-A3A9-1E080342F867}.Release|Any CPU.Build.0 = Release|Any CPU + {462CDBD4-0DDA-4854-1B13-CFDACBFB66F5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {462CDBD4-0DDA-4854-1B13-CFDACBFB66F5}.Debug|Any CPU.Build.0 = Debug|Any CPU + {462CDBD4-0DDA-4854-1B13-CFDACBFB66F5}.DebugNoUnity|Any CPU.ActiveCfg = Debug|Any CPU + {462CDBD4-0DDA-4854-1B13-CFDACBFB66F5}.dev|Any CPU.ActiveCfg = Debug|Any CPU + {462CDBD4-0DDA-4854-1B13-CFDACBFB66F5}.dev|Any CPU.Build.0 = Debug|Any CPU + {462CDBD4-0DDA-4854-1B13-CFDACBFB66F5}.Release|Any CPU.ActiveCfg = Release|Any CPU + {462CDBD4-0DDA-4854-1B13-CFDACBFB66F5}.Release|Any CPU.Build.0 = Release|Any CPU + {6B0EAB30-511A-44C1-87FE-D9AB7E34D115}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {6B0EAB30-511A-44C1-87FE-D9AB7E34D115}.Debug|Any CPU.Build.0 = Debug|Any CPU + {6B0EAB30-511A-44C1-87FE-D9AB7E34D115}.DebugNoUnity|Any CPU.ActiveCfg = Debug|Any CPU + {6B0EAB30-511A-44C1-87FE-D9AB7E34D115}.DebugNoUnity|Any CPU.Build.0 = Debug|Any CPU + {6B0EAB30-511A-44C1-87FE-D9AB7E34D115}.dev|Any CPU.ActiveCfg = dev|Any CPU + {6B0EAB30-511A-44C1-87FE-D9AB7E34D115}.dev|Any CPU.Build.0 = dev|Any CPU + {6B0EAB30-511A-44C1-87FE-D9AB7E34D115}.Release|Any CPU.ActiveCfg = Release|Any CPU + {6B0EAB30-511A-44C1-87FE-D9AB7E34D115}.Release|Any CPU.Build.0 = Release|Any CPU + {F94F8AE1-C171-4A83-89E8-6557CA91A188}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {F94F8AE1-C171-4A83-89E8-6557CA91A188}.Debug|Any CPU.Build.0 = Debug|Any CPU + {F94F8AE1-C171-4A83-89E8-6557CA91A188}.DebugNoUnity|Any CPU.ActiveCfg = Debug|Any CPU + {F94F8AE1-C171-4A83-89E8-6557CA91A188}.DebugNoUnity|Any CPU.Build.0 = Debug|Any CPU + {F94F8AE1-C171-4A83-89E8-6557CA91A188}.dev|Any CPU.ActiveCfg = dev|Any CPU + {F94F8AE1-C171-4A83-89E8-6557CA91A188}.dev|Any CPU.Build.0 = dev|Any CPU + {F94F8AE1-C171-4A83-89E8-6557CA91A188}.Release|Any CPU.ActiveCfg = Release|Any CPU + {F94F8AE1-C171-4A83-89E8-6557CA91A188}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE @@ -106,5 +183,10 @@ Global {66A1D219-F61D-4AE4-9BD7-AAEB97276FFF} = {D17F1B4C-42DC-4E78-BCEF-9F239A084C4D} {1A382F40-FD9E-43E1-89C1-320073F35CE9} = {D17F1B4C-42DC-4E78-BCEF-9F239A084C4D} {08B87D2A-8CF1-4211-B7AA-5209F00F72F8} = {D17F1B4C-42DC-4E78-BCEF-9F239A084C4D} + {3DD3451C-30FA-4294-A3A9-1E080342F867} = {D17F1B4C-42DC-4E78-BCEF-9F239A084C4D} + {462CDBD4-0DDA-4854-1B13-CFDACBFB66F5} = {D17F1B4C-42DC-4E78-BCEF-9F239A084C4D} + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {66BD4D50-3779-4912-9596-2C838BF24911} EndGlobalSection EndGlobal diff --git a/GitHub.Unity.sln.DotSettings b/GitHub.Unity.sln.DotSettings index d4374a413..2166c735a 100644 --- a/GitHub.Unity.sln.DotSettings +++ b/GitHub.Unity.sln.DotSettings @@ -22,8 +22,11 @@ END_OF_LINE 1 1 + False + False False True + NEVER False True False @@ -335,11 +338,17 @@ </TypePattern> </Patterns> ID + MD SSH <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> + True + True + True + True True True + True True True True diff --git a/LICENSE b/LICENSE index 32e3acbc9..a306528ee 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2016 GitHub +Copyright (c) 2016-2019 GitHub Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 71571e1c0..1cd67b951 100644 --- a/README.md +++ b/README.md @@ -1,184 +1,36 @@ # [GitHub for Unity](https://unity.github.com) -## Notices - -From version 0.19 onwards, the location of the plugin has moved to `Assets/Plugins/GitHub`. If you have version 0.18 or lower, you need to delete the `Assets/Editor/GitHub` folder before you install newer versions. You should exit Unity and delete the folder from Explorer/Finder, as Unity will not unload native libraries while it's running. Also, remember to update your `.gitignore` file. - -![Build Status](https://ci.appveyor.com/api/projects/status/github/github-for-unity/Unity?branch=master&svg=true) +## NOTICE OF DEPRECATION -[![Join the chat at https://gitter.im/github-for-unity/Unity](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/github-for-unity/Unity?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -[![Join the chat at https://discord.gg/5zH8hVx](https://img.shields.io/badge/discord-join%20chat-7289DA.svg)](https://discord.gg/5zH8hVx) -[![GitHub for Unity live coding on Twitch](https://img.shields.io/badge/twitch-live%20coding-6441A4.svg)](https://www.twitch.tv/sh4na) +This project is dead y'all! Remove GitHub for Unity from your project, then go to https://github.com/spoiledcat/git-for-unity and install Git for Unity from the instructions there. -## About +# What is it The GitHub for Unity extension brings [Git](https://git-scm.com/) and GitHub into [Unity](https://unity3d.com/), integrating source control into your work with friendly and accessible tools and workflows. -**Please note:** this software is currently alpha quality. Please refer to the [list of known issues](https://github.com/github-for-unity/Unity/issues?q=is%3Aissue+is%3Aopen+label%3Abug), and make sure you have backups of your work before trying it out. - -#### Table Of Contents - -[Installing GitHub for Unity](#installing-github-for-unity) - * [Requirements](#requirements) - * [Git on macOS](#git-on-macos) - * [Git on Windows](#git-on-windows) - * [Installation](#installation) - * [Log files](#log-files) - * [Windows](#windows) - * [macOS](#macos) - -[Building and Contributing](#building-and-contributing) - -[Quick Guide to GitHub for Unity](#quick-guide-to-github-for-unity) - * [Opening the GitHub window](#opening-the-github-window) - * [Initialize Repository](#initialize-repository) - * [Authentication](#authentication) - * [Publish a new repository](#publish-a-new-repository) - * [Commiting your work - Changes tab](#commiting-your-work---changes-tab) - * [Pushing/pulling your work - History tab](#pushingpulling-your-work---history-tab) - * [Branches tab](#branches-tab) - * [Settings tab](#settings-tab) - -[More Resources](#more-resources) - -[License](#license) - -## Installing GitHub for Unity - -### Requirements - -- Unity 5.4-2017.1 - - We've only tested the extension so far on Unity 5.4 to 2017.1. There's currently an blocker issue opened for 5.3 support, so we know it doesn't run there. There are some issues for 2017.2, so it may or may not run well on that version. Personal edition is fine. -- Git and Git LFS 2.x - -#### Git on macOS - -The current release has limited macOS support. macOS users will need to install the latest [Git](https://git-scm.com/downloads) and [Git LFS](https://git-lfs.github.com/) manually, and make sure these are on the path. You can configure the Git location in the Settings tab on the GitHub window. - -The easiest way of installing git and git lfs is to install [Homebrew](https://brew.sh/) and then do `brew install git git-lfs`. +You can reach the team right here by opening a [new issue](https://github.com/github-for-unity/Unity/issues/new). You can also tweet at [@GitHubUnity](https://twitter.com/GitHubUnity) -Make sure a Git user and email address are set in the `~/.gitconfig` file before you initialize a repository for the first time. You can set these values by opening your `~/.gitconfig` file and adding the following section, if it doesn't exist yet: +[![Build Status](https://ci.appveyor.com/api/projects/status/github/github-for-unity/Unity?branch=master&svg=true)](https://ci.appveyor.com/project/github-windows/unity) -``` -[user] - name = Your Name - email = Your Email -``` - -#### Git on Windows - -The GitHub for Unity extension ships with a bundle of Git and Git LFS, to ensure that you have the correct version. These will be installed into `%LOCALAPPDATA%\GitHubUnity` when the extension runs for the first time. - -Make sure a Git user and email address are set in the `%HOME%\.gitconfig` file before you initialize a repository for the first time. You can set these values by opening your `%HOME%\.gitconfig` file and adding the following section, if it doesn't exist yet: - -``` -[user] - name = Your Name - email = Your Email -``` - -Once the extension is installed, you can open a command line with the same Git and Git LFS version that the extension uses by going to the `GitHub` -> `Command line` menu in Unity. - -### Installation - -This extensions needs to be installed (and updated) for each Unity project that you want to version control. -First step is to download the latest package from [the releases page](https://github.com/github-for-unity/Unity/releases); -it will be saved as a file with the extension `.unitypackage`. -To install it, open Unity, then open the project you want to version control, and then double click on the downloaded package. -Alternatively, import the package by clicking Assets, Import Package, Custom Package, then select the downloaded package. - -#### Log files - -##### macOS - -The extension log file can be found at `~/.local/share/GitHubUnityDebug/github-unity.log`. This is a temporary location and will be changed in the future. +## Notices -##### Windows +Please refer to the [list of known issues](https://github.com/github-for-unity/Unity/issues?q=is%3Aissue+is%3Aopen+label%3Abug), and make sure you have backups of your work before trying it out. -The extension log file can be found at `%LOCALAPPDATA%\GitHubUnity\github-unity.log` +From version 0.19 onwards, the location of the plugin has moved to `Assets/Plugins/GitHub`. If you have version 0.18 or lower, you need to delete the `Assets/Editor/GitHub` folder before you install newer versions. You should exit Unity and delete the folder from Explorer/Finder, as Unity will not unload native libraries while it's running. Also, remember to update your `.gitignore` file. ## Building and Contributing -The [CONTRIBUTING.md](CONTRIBUTING.md) document will help you get setup and familiar with the source. The [documentation](docs/) folder also contains more resources relevant to the project. - Please read the [How to Build](docs/contributing/how-to-build.md) document for information on how to build GitHub for Unity. -If you're looking for something to work on, check out the [up-for-grabs](https://github.com/github-for-unity/Unity/issues?q=is%3Aopen+is%3Aissue+label%3Aup-for-grabs) label. - - -## I have a problem with GitHub for Unity - -First, please search the [open issues](https://github.com/github-for-unity/Unity/issues?q=is%3Aopen) -and [closed issues](https://github.com/github-for-unity/Unity/issues?q=is%3Aclosed) -to see if your issue hasn't already been reported (it may also be fixed). - -If you can't find an issue that matches what you're seeing, open a [new issue](https://github.com/github-for-unity/Unity/issues/new) -and fill out the template to provide us with enough information to investigate -further. - -## Quick Guide to GitHub for Unity - -### Opening the GitHub window - -You can access the GitHub window by going to Windows -> GitHub. The window opens by default next to the Inspector window. - -### Initialize Repository - -![Initialize repository screenshot](https://user-images.githubusercontent.com/121322/27644875-7fc6302a-5bd9-11e7-98d0-c09b2e450503.png) - -If the current Unity project is not in a Git repository, the GitHub for Unity extension will offer to initialize the repository for you. This will: - -- Initialize a git repository at the Unity project root via `git init` -- Initialize git-lfs via `git lfs install` -- Set up a `.gitignore` file at the Unity project root. -- Set up a `.gitattributes` file at the Unity project root with a large list of known binary filetypes (images, audio, etc) that should be tracked by LFS -- Configure the project to serialize meta files as text -- Create an initial commit with the `.gitignore` and `.gitattributes` file. - -### Authentication - -To set up credentials in Git so you can push and pull, you can sign in to GitHub by going to `Window` -> `GitHub` -> `Account` -> `Sign in`. You only have to sign in successfully once, your credentials will remain on the system for all Git operations in Unity and outside of it. If you've already signed in once but the Account dropdown still says `Sign in`, ignore it, it's a bug. - -![Authentication screenshot](https://user-images.githubusercontent.com/121322/27644895-8f22f904-5bd9-11e7-8a93-e6bfe0c24a74.png) - -### Publish a new repository - -1. Go to [github.com](https://github.com) and create a new empty repository - do not add a license, readme or other files during the creation process. -2. Copy the **https** URL shown in the creation page -3. In Unity, go to `Windows` -> `GitHub` -> `Settings` and paste the url into the `Remote` textbox. -3. Click `Save repository`. -4. Go to the `History` tab and click `Push`. - -### Commiting your work - Changes tab - -You can see which files have been changed and commit them through the Changes tab. `.meta` files will show up in relation to their files on the tree, so you can select a file for comitting and automatically have their `.meta` - -![Changes tab screenshot](https://user-images.githubusercontent.com/121322/27644933-ab00af72-5bd9-11e7-84c3-edec495f87f5.png) - -### Pushing/pulling your work - History tab - -The history tab includes a `Push` button to push your work to the server. Make sure you have a remote url configured in the `Settings` tab so that you can push and pull your work. - -To receive updates from the server by clicking on the `Pull` button. You cannot pull if you have local changes, so commit your changes before pulling. - -![History tab screenshot](https://user-images.githubusercontent.com/121322/27644965-c1109bba-5bd9-11e7-9257-4fa38f5c67d1.png) - -### Branches tab - -![Branches tab screenshot](https://user-images.githubusercontent.com/121322/27644978-cd3c5622-5bd9-11e7-9dcb-6ae5d5c7dc8a.png) - -### Settings tab - -You can configure your user data in the Settings tab, along with the path to the Git installation. +The [CONTRIBUTING.md](CONTRIBUTING.md) document will help you get setup and familiar with the source. The [documentation](docs/) folder also contains more resources relevant to the project. -Locked files will appear in a list in the Settings tab. You can see who has locked a file and release file locks after you've pushed your work. +If you're looking for something to work on, check out the [up-for-grabs](https://github.com/github-for-unity/Unity/issues?q=is%3Aopen+is%3Aissue+label%3Aup-for-grabs) label. -![Settings tab screenshot](https://user-images.githubusercontent.com/121322/27644993-d9d325a0-5bd9-11e7-86f5-beee00e9e8b8.png) +## How to use -## More Resources +The [quick guide to GitHub for Unity](docs/using/quick-guide.md) -See [unity.github.com](https://unity.github.com) for more product-oriented -information about GitHub for Unity. +More [in-depth information](docs/readme.md) ## License @@ -188,6 +40,6 @@ The MIT license grant is not for GitHub's trademarks, which include the logo designs. GitHub reserves all trademark and copyright rights in and to all GitHub trademarks. GitHub's logos include, for instance, the stylized Invertocat designs that include "logo" in the file title in the following -folder: [IconsAndLogos](https://github.com/github-for-unity/Unity/tree/master/src/UnityExtension/Assets/Editor/GitHub.Unity/IconsAndLogos). +folder: [IconsAndLogos](src/UnityExtension/Assets/Editor/GitHub.Unity/IconsAndLogos). -Copyright 2015 - 2017 GitHub, Inc. +Copyright 2015 - 2018 GitHub, Inc. diff --git a/appveyor.yml b/appveyor.yml index a5d0c4580..bfb3e1b77 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -1,35 +1,28 @@ -version: '{build}.{branch}' environment: GHFU_KEY: secure: KFcQA1VOCEMGUgy2dxH8G5O7C9DsAtQrnc6LakFpd9BRFtNnt2E8RSadPoJwQ9gztWaLS8vQLdU7cV5Ivt01LOnPI2kU1fQd2SHtKwJFve8ppvK/yZ/luhiXvIdGeEAiXQyuc1WUwuECoJVA6n7/uQKr1Q+eHniMitHuFpyQ7OqnwF6f+4TeBS6D78fKd3QoeP4XDdxCjNWPNmLv7BvWFMm5CuTK9aAWhOy8em/nVIED8qt36uHnncsDn+DH7uunj+VwmhVS+4yhuKHHz5naiUAHHIziZ4wBW6Q8rcf7xYEeISjlfxJ6TXs4Wwp406AO+n3v1DZaxSXwvoxplfopeGyb6imJfbwdTU/MHf2uj9wXobR8UhDarcrugVW+J3bqZyvkg20HfSe80gfQUBlK5OdMAp58dhWkddvJSO5TnzqmLlo/60gZxjheIbjdLaavSKcM4xOALXQlBbJJgVQrB/F6tYf7pRK3BlS8VoakyOGjJRzsSNdssSVrLVW3rwANORbH6Z1ZYvQw2ObP6/EBMceer0+JV4y9zB5q9C68erlr1NtJB0xKUp9/7I5GQj4lJ+pDsaFdsj40SyyD4yazSZf/3VIhZi/rQTJm0Ft0ifTZGSxnNTOVMZ5fsoJmUL0bn75Xt9q59cKYzK041HtEzRSElnBeuTf+Sm/MLLV28P1sonwntMhcYQ5ZPIuGmKa8jAJ0kxPXyT56MPJpwbNrbCOw2t9hXg5QbYv/+0RcoRoJ7P/5OY3M6mj8Emtu8N0SFKD6lfv9KNLFAyBuF6Ml7RyOs5RRogIdEapegTY7jwGH7igibrP0lt6HYshM7hKQrRYm2saokBV9TfgV9qnPyGs5/zyTTUGW4y0LavxiXl/vQIpxwCg4liCf1Dgw4Zrxvh40bziKGc3X06RJcysJ8cskOi6gB8eK8VTbAy6/Ufgv+pyjIns1iJxmdVbl8MrlgPXmOephdRPYZJDiFd4ynw0Slm1mqbzPWHdQ/mtMGxNRcysIOPKzKaKvK7Syor5SNtv4HU097dyjVQyW9krHaX/DSnx++dMDCIZJEDYxFw7LmTvl6AFWU4C3HM7+26cHBuBMBYS1PwcRijG+hwsHiXIomVuVglcxp5HC2eFbtBF9h1g030/tCeIBhZIVdSVO78319CsL1+aVtI5WjeQglH1OcTS42OF1Nb/4EjaN4I/w6yRJU5dmK7Q+rHQ+7NnPT4n5flQV6oe1XNbLen0raDuGos6v+aaoOQ50HlCSMMBJ3liapVXIAQ+Z/XM/cNZZa1TB6/C363Hjrts6Uq3IjKXmomhA33je+Wl6mTZqBucXUJs76p+ZgKubWvfzK/e6tORJggAgFNoa9Y56r3t7J8UdUolt301I1cCVz9CvYMUsWTmjKTR5SpssbbcuRcFUhgkHrhsSq0rBef/dfn5VEP8sateiqbpMne5iWO4Wc0Qx2/fJfx2zf9oqO3MihAyYDwPI7JCrmccJY9cHV89YlrytZuh87aBQ8d+T5ELdeG3bbYGYbKJ/yOGxMo8cRSomWUp2809Ea/lgu6WjyY1SdEjh20fwONOTRd/AA3h3XIMU7NY999YOEy1zj3yeP+awozDWQU8GSojA/ceLU5HT0U/RT2XJgkzUFb/u8wanNG6InPqvZy01bLR8JZmqXZl/4XgNpEsbzwPxjzuZJP6O4f2Usq1ZmHUfwlouXLWuHTv5/DPYJ9kO91wjzAH46IsoadmQkRDomHYCDPRCnYoS2zBkmBNukCgCKWsSwD5Msw/tpgIorMi5AAFhIOeWt/7tcKZ5nslbbnmZFtDkOBriPEiOjrAziRqFNAdBjecMrckRQrlkYjkpJG/pXZXYq219/8Sy1/HdNrWTCdq7nc947Fvq41CfumT4c2TqhVc/oflJ9SaxIl2A1Vtbw5LkmQKL08vOitsyZgRupcbqLcSYGo2dG+ks0gK5o2rvNp1nyN3ADh7JFmtD7/og55zlsAj7wP6rLEZ44h+dk7+Sh96WoCPfzSJnchg2vsydTpK6sG3Cp5qjEk0Tps88nX0SPvEPxwEpBL08+XIlg5OVxiTIYI0NSeEjAxwip2ptgaeI4c0yPB5SahMArEw/8YeEflWhiDyjoG4Bw0O1v9fRSSYiFhcYwrkr6yBK81hx6uH6DzqDqtKOxwJ3kKhapfwZXStmeOt4AwiSUHO8TiX1t0i7Jqwl7mRduz3LfmqGCeEsNxnLuhc6MPeEva8LO8ILCEcVz8bHlwUMWqabdZRm9UtbWtZp/u8ffPSBbgNFna2kKFr/F7dmXiv18CpNHOGxb/rSdmIaov1nXJR7XUyKPRO548PHE6iNxuNjWjcuFw1L0IUCNEeVUs7tvNHUTYOXRvfXNm3DbhjFnGix2JVCB2xz6QhDV4Hh6y0/rJl0b2dW25iM5HZdwCBGwgGM+9HyD7r+OBiRn+rd996c81+JsWL4jsa//16uwcbEpsF3tAB7b0by4qHbeZ+Gs3M06Sje4UVpLgKQVHSd/hfo4M70v3APhyz0WFBhLLZyouz0OdazKZ4W+HGBcunAPw/sYdMYZLe4ZmA6B+wxtSzojNKFaCFWoh3S5vLClZTraj7Mhh02PPsY0fmo15ceHBwKjMfGZ0pXt8uiPL29ECUstxSLVnPv6M4uXPJa7k+0lvj7XdB7aJ/LzexPAa/Z1+hsr2sO9An5qPnKM5Tp5zj9Xq2T7WBiDObYLxYZX5ez32jKfSYgv3cpIo5HnhKB3rZL3Alp6iJ2NFsDiB6pIUc2YQ3UU8wiMU90ifA83ORttzRDdLCuH1lYCHPk8rcVqeydgNrI4pRVrdIah3wm6hHc7YjSSnjIOhcl286iVtYgn10RUKxcs//ElgoGm0IkefKRy2WcDDL+10ZifpSWxRu0yrpwlxd0uHCAhrkOEnvaamn+0TSu/6s9VxoUyn9ZJhY7Jgnb6Z9Qxi4C+u2vXf6lOQvzl4AawnD9DW+w2L6hr2njGhvgjj2VLIHM/GIOV/OaYW97AiW0NBuEGDyBiuj8TxIUL7IuVj+QZVfyUzZHHL0c0Hy4jlQ+sh2nFzOAGWVZwEdAvLl9JCCs46iA9DHtBSrHxit7lytyspp7q8TYfE1lA0pIwkx20E3t+4CNdUQAr/IJaZJxhdfKAyW3UipP4LdRbweyYHZYFkoN0gEDMrzE0yB7XFNw5ddm/+o8KIuSUl44UVFcp2j0KPfuXadx7Pz1aa5HKpVUdc5CfJOjqgPJFn/MQU702YdUaV0qD+EHDOiVv313gUHdy9kpieQ3s2LDSh0qBkPdxLAdYXKLP24Mj3V+A2lyHU1WtLrIEVP37eCAFSYPf6Lz6TW4zrEBpHF4nwlE8M+0jQ/oB4lINxnkCa3YKYLFMiZ3dAmqGzVElesgymmB21xvdfrHgB1Z5OtQqYT8PPAw6llujXv6Pj9CqDGGS4U8UeW5GCFi/qyV6+hdg2IUsWtSzkbLJ5n8cfafEYeRBRgzK/B6qlTmoOrRl+bzmjVCJX29P+38KCpu7srnSQ+T0fR6t0OWyHGfC/39iMzATnhpiIXdnngVV9Cypgod5we44C2Rb4Or/nr5mdEidElIIthDiD7GHPNSeMXrdxs+ow76rh42DiY7x0L0SMRWyUEz0seL1JdBCdNn/7LuSn4CVpggqZD8anf9n+IUjrJtqQ+AvaogfuxM65byhGK4iVIijrogfBHb4nGywXxeEKe03JJ8nOWWN2ndyNhMW1dfNGraHvAt7DWL+/tp4qKCA89VFaZjwsqINANF1VVwh96SB6qT4tlKJjaPD3YpawT6Jfs+cg3pMj36FIPzHoNd/r+LwCBZ0WiA5xZiO0DX6WhwTfJVStsz4i9VXElCmWF2dpf5kTEC0T62Y1VCc++M1cTfwX34mdHPvdsm1Vi1qpqz4HTez8ateFukyj1FIN7++eYWoBJBoclhb3y/VUFwepORi84pz1fXUSSl8Fpg2U7NRyj+gcM5v/VAC1FGR4CJVpODIdROF7mCrLTbPzLn8Fv7EJHgHKNeU/sIT13+5V/UJSZPAxWcaUKhRWWuShSVb/1U13LjiWkHvmuH7SVLHbJDO5C5lA589rz4weTMd1OSymPuNB/xj2d2YrJUwqB3olsaxwm8w/bs2ot4GF4HFAdx3l0ESiR8jkBNAvr6vwRcXv+7nfXRpx2Mo5QU2YaunbqZxibmtNCQZBH8ZpQyUZOek4A5qDh6HW2VyJqKXeE8u1fbtOzB9xDYxgTrlVFhCw== -clone_script: -- ps: >- - if(-not $env:appveyor_pull_request_number) { - git lfs clone -q -n --branch=$env:appveyor_repo_branch https://github.com/$env:appveyor_repo_name.git $env:appveyor_build_folder - git checkout -qf $env:appveyor_repo_commit - } else { - git lfs clone -q -n https://github.com/$env:appveyor_repo_name.git $env:appveyor_build_folder - git fetch -q origin +refs/pull/$env:appveyor_pull_request_number/merge: - git lfs fetch origin FETCH_HEAD - git checkout -qf FETCH_HEAD - } - - Set-Location $env:appveyor_build_folder + matrix: + - node_version: '8' install: - ps: >- + $full_build = Test-Path env:GHFU_KEY + + $package = $full_build + git submodule sync git submodule init - $full_build = Test-Path env:GHFU_KEY - if ($full_build) { + $env:BUILD_TYPE="full" $fileContent = "-----BEGIN RSA PRIVATE KEY-----`n" $fileContent += $env:GHFU_KEY.Replace(' ', "`n") $fileContent += "`n-----END RSA PRIVATE KEY-----`n" Set-Content c:\users\appveyor\.ssh\id_rsa $fileContent + Install-Product node $env:node_version } else { + $env:BUILD_TYPE="partial" git submodule deinit script $destdir = Join-Path $env:appveyor_build_folder 'lib' $destfile = Join-Path $destdir 'deps.zip' @@ -43,6 +36,24 @@ install: nuget restore GitHub.Unity.sln + Set-Location $env:appveyor_build_folder + + $version = Get-Content "$($env:appveyor_build_folder)\common\SolutionInfo.cs" | %{ $regex = "const string GitHubForUnityVersion = `"([^`"]*)`""; if ($_ -match $regex) { $matches[1] } } + + $env:package_version="$($version).$($env:APPVEYOR_BUILD_NUMBER)" + + Update-AppveyorBuild -Version $env:package_version + + $message = "Building " + + if ($package) { $message += "and packaging "} + + if ($full_build) { $message += "(full build)" } else { $message += "(partial build)" } + + $message += " version " + $env:package_version + " " + + Write-Host $message + assembly_info: patch: false file: common\SolutionInfo.cs @@ -53,13 +64,44 @@ build: project: GitHub.Unity.sln verbosity: minimal test: + assemblies: + except: + - '**\*.TestRunner.dll' + - '**\*.TestUtils.dll' categories: except: - DoNotRunOnAppVeyor -artifacts: -- path: unity\PackageProject - type: zip - name: github-for-unity-packageproject -- path: build\*.log -on_failure: - - ps: Get-ChildItem build\*.log | % { Push-AppveyorArtifact $_.FullName -FileName $_.Name } +on_success: +- ps: | + if ($package) { + $rootdir=$env:appveyor_build_folder + Set-Location $rootdir + $sourcedir="$rootdir\unity\PackageProject" + $packagename="github-for-unity-$($env:package_version)" + $packagefile="$rootdir\$($packagename).unitypackage" + $commitfile="$sourcedir\commit" + $zipfile="$rootdir\PackageProject-$($env:package_version).zip" + + # generate mdb files + Write-Output "Generating mdb files" + Get-ChildItem -Recurse "$($sourcedir)\*.pdb" | foreach { $_.fullname.substring(0, $_.fullname.length - $_.extension.length) } | foreach { Write-Output "Generating $($_).mdb"; & 'lib\pdb2mdb.exe' "$($_).dll" } + + # generate unitypackage + Write-Output "Generating $packagefile" + submodules\packaging\unitypackage\run.ps1 -PathToPackage:$sourcedir -OutputFolder:$rootdir -PackageName:$packagename + + # save commit + Add-Content $commitfile $appveyor_repo_commit + + Write-Output "Zipping $sourcedir to $zipfile" + 7z a $zipfile $sourcedir + + Write-Output "Uploading $zipfile" + Push-AppveyorArtifact $zipfile -DeploymentName source + Push-AppveyorArtifact $packagefile -DeploymentName package + Push-AppveyorArtifact "$($packagefile).md5" -DeploymentName package + } +on_finish: +- ps: | + Set-Location $env:appveyor_build_folder + Get-ChildItem $env:appveyor_build_folder\build\*.log | % { Push-AppveyorArtifact $_.FullName -FileName $_.Name -DeploymentName logs } diff --git a/build.sh b/build.sh index 2ebedc2c0..900c994f7 100755 --- a/build.sh +++ b/build.sh @@ -29,7 +29,7 @@ fi if [ x"$OS" == x"Windows" ]; then common/nuget restore GitHub.Unity.sln else - nuget restore GitHub.Unity.sln + mono common/nuget.exe restore GitHub.Unity.sln fi xbuild GitHub.Unity.sln /verbosity:minimal /property:Configuration=$Configuration /target:$Target || true diff --git a/common/SolutionInfo.cs b/common/SolutionInfo.cs index bbde9c488..eb95db6a0 100644 --- a/common/SolutionInfo.cs +++ b/common/SolutionInfo.cs @@ -6,12 +6,12 @@ using System.Runtime.InteropServices; [assembly: AssemblyProduct("GitHub for Unity")] -[assembly: AssemblyVersion(System.AssemblyVersionInformation.Version)] -[assembly: AssemblyFileVersion(System.AssemblyVersionInformation.Version)] +[assembly: AssemblyVersion(System.AssemblyVersionInformation.VersionForAssembly)] +[assembly: AssemblyFileVersion(System.AssemblyVersionInformation.VersionForAssembly)] [assembly: AssemblyInformationalVersion(System.AssemblyVersionInformation.Version)] [assembly: ComVisible(false)] [assembly: AssemblyCompany("GitHub, Inc.")] -[assembly: AssemblyCopyright("Copyright GitHub, Inc. 2017")] +[assembly: AssemblyCopyright("Copyright GitHub, Inc. 2016-2019")] [assembly: AssemblyConfiguration("")] [assembly: AssemblyTrademark("")] [assembly: AssemblyCulture("")] @@ -31,6 +31,10 @@ namespace System { internal static class AssemblyVersionInformation { - internal const string Version = "0.27.0"; + private const string GitHubForUnityVersion = "1.4.0"; + internal const string VersionForAssembly = GitHubForUnityVersion; + + // If this is an alpha, beta or other pre-release, mark it as such as shown below + internal const string Version = GitHubForUnityVersion; // GitHubForUnityVersion + "-beta1" } } diff --git a/common/build.targets b/common/build.targets index cb88330c3..163a071a8 100644 --- a/common/build.targets +++ b/common/build.targets @@ -5,40 +5,22 @@ Properties\SolutionInfo.cs - - Properties\GitHub.ruleset + + Properties\codeanalysis-release.ruleset + + + Properties\codeanalysis-debug.ruleset - - - - - {9862694d-e4fa-418b-8692-a0280feddf36} - System.Net.Http-net_3_5 - - - {49ef16a2-5ed1-480f-80a1-d1d05d6c1be4} - Octokit-35 - - - - - - - $(SolutionDir)lib\octokit.net\Octokit.dll - - - $(SolutionDir)lib\dotnet-httpclient35\System.Net.Http.dll - - - - - - Location of Unity dlls is not set. You'll need to install Unity in a known location (the default installation directory for your system), or copy UnityEngine.dll and UnityEditor.dll to the {0}lib folder + The location of Unity dlls is not set. You'll need to install Unity in a known location (the default installation directory for your system), or: + - Copy UnityEngine.dll and UnityEditor.dll to the {0}lib\Managed folder + - Copy UnityEngine.TestRunner.dll to the {0}lib\UnityExtensions/Unity/TestRunner folder + - Copy UnityEditor.TestRunner.dll to the {0}lib\UnityExtensions/Unity/TestRunner/Editor folder + To build the OctokitDebugging solution you need to have https://github.com/github-for-unity/octokit.net checked out in {0} To build the OctokitDebugging solution you need to have https://github.com/github-for-unity/dotnet-httpclient35 checked out in {0} diff --git a/common/codeanalysis-small.ruleset b/common/codeanalysis-debug.ruleset similarity index 84% rename from common/codeanalysis-small.ruleset rename to common/codeanalysis-debug.ruleset index b380093ab..5aba57f2b 100644 --- a/common/codeanalysis-small.ruleset +++ b/common/codeanalysis-debug.ruleset @@ -1,5 +1,5 @@  - + @@ -86,7 +86,6 @@ - @@ -94,6 +93,26 @@ + + + + + + + + + + + + + + + + + + + + diff --git a/common/codeanalysis-full.ruleset b/common/codeanalysis-release.ruleset similarity index 83% rename from common/codeanalysis-full.ruleset rename to common/codeanalysis-release.ruleset index 0985eed76..c93efbfa4 100644 --- a/common/codeanalysis-full.ruleset +++ b/common/codeanalysis-release.ruleset @@ -80,6 +80,28 @@ + + + + + + + + + + + + + + + + + + + + + + diff --git a/common/packaging.targets b/common/packaging.targets index 77f866e20..a5ddd41a5 100644 --- a/common/packaging.targets +++ b/common/packaging.targets @@ -7,8 +7,9 @@ @@ -22,16 +23,16 @@ + Condition="!$([System.String]::Copy('%(Filename)').Contains('deleteme')) and !$([System.String]::Copy('%(Extension)').Contains('xml'))" /> - + - + diff --git a/common/properties.props b/common/properties.props index 9d7fd40c6..8316329ed 100644 --- a/common/properties.props +++ b/common/properties.props @@ -2,14 +2,27 @@ - OctokitDebugging Internal + ENABLE_METRICS + $(BuildDefs);ENABLE_MONO - $(SolutionDir)\script\lib\ - $(SolutionDir)\lib\ - C:\Program Files\Unity\Editor\Data\Managed\ + $(SolutionDir)script\lib\ + $(SolutionDir)lib\ + C:\Program Files\Unity\Editor\Data\ C:\Program Files (x86)\Unity\Editor\Data\Managed\ - \Applications\Unity\Unity.app\Contents\Managed\ - Debug + \Applications\Unity\Unity.app\Contents\ + Debug + $(Configuration) + + + $(SolutionDir)\common\codeanalysis-debug.ruleset + + + $(SolutionDir)\common\codeanalysis-release.ruleset + + + $(SolutionDir)\common\codeanalysis-debug.ruleset + + \ No newline at end of file diff --git a/create-octorun-zip.sh b/create-octorun-zip.sh new file mode 100755 index 000000000..4eb568d33 --- /dev/null +++ b/create-octorun-zip.sh @@ -0,0 +1,3 @@ +#!/bin/sh -eu +DIR=$(pwd) +submodules/packaging/octorun/run.sh --path $DIR/octorun --out $DIR/src/GitHub.Api/Resources --source $DIR/src/GitHub.Api/Installer diff --git a/create-unitypackage.sh b/create-unitypackage.sh new file mode 100755 index 000000000..333f7cb90 --- /dev/null +++ b/create-unitypackage.sh @@ -0,0 +1,9 @@ +#!/bin/sh -eu +DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" + +version=$(sed -En 's,.*GitHubForUnityVersion = "(.*)".*,\1,p' common/SolutionInfo.cs) +commitcount=$(git rev-list --count HEAD) +commit=$(git log -n1 --pretty=format:%h) +version="${version}.${commitcount}-${commit}" + +$DIR/submodules/packaging/unitypackage/run.sh --path $DIR/unity/PackageProject --out $DIR --file github-for-unity-$version diff --git a/CREDITS.txt b/credits.txt similarity index 88% rename from CREDITS.txt rename to credits.txt index e7137d888..b8fb5d7e1 100644 --- a/CREDITS.txt +++ b/credits.txt @@ -1,31 +1,5 @@ =============================================================================== -Port of Mono's System.Net.Http (https://github.com/shana/dotnet-httpclient35) -=============================================================================== - -Copyright (c) 2001, 2002, 2003 Ximian, Inc and the individuals listed -on the ChangeLog entries. - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - -=============================================================================== -Port of Axosoft's NSFW (https://github.com/StanleyGoldman/sfw) +Port of Axosoft's NSFW (https://github.com/github-for-unity/sfw) =============================================================================== The MIT License (MIT) @@ -50,29 +24,6 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -=============================================================================== -Octokit.NET (https://github.com/editor-tools/octokit.net/tree/net3.5) -=============================================================================== - -Copyright (c) 2012 GitHub, Inc. - -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of -the Software, and to permit persons to whom the Software is furnished to do so, -subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS -FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - =============================================================================== AsyncBridge (https://github.com/OmerMor/AsyncBridge) =============================================================================== diff --git a/docs/contributing/how-to-build.md b/docs/contributing/how-to-build.md index ed32b7e5d..13ef8c2fa 100644 --- a/docs/contributing/how-to-build.md +++ b/docs/contributing/how-to-build.md @@ -13,7 +13,7 @@ This repository is LFS-enabled. To clone it, you should use a git client that su ### MacOS -- Mono 4.x required. +- [Mono 4.x](https://download.mono-project.com/archive/4.8.1/macos-10-universal/) required. You can install it via brew with `brew tap shana/mono && brew install mono@4.8` - Mono 5.x will not work - `UnityEngine.dll` and `UnityEditor.dll`. - If you've installed Unity in the default location of `/Applications/Unity`, the build will be able to reference these DLLs automatically. Otherwise, you'll need to copy these DLLs from `[Unity installation path]/Unity.app/Contents/Managed` into the `lib` directory in order for the build to work @@ -35,12 +35,25 @@ git submodule deinit script ### Important pre-build steps -To be able to authenticate in GitHub for Unity, you'll need to: +The build needs to reference `UnityEngine.dll` and `UnityEditor.dll`. These DLLs are included with Unity. If you've installed Unity in the default location, the build will be able to find them automatically. If not, copy these DLLs from `[your Unity installation path]\Unity\Editor\Data\Managed` into the `lib` directory in order for the build to work. + +#### Developer OAuth app + +Because GitHub for Unity uses OAuth web application flow to interact with the GitHub API and perform actions on behalf of a user, it needs to be bundled with a Client ID and Secret. + +For external contributors, we have bundled a developer OAuth application in the source so that you can complete the sign in flow locally without needing to configure your own application. + +These are listed in `src/GitHub.Api/Application/ApplicationInfo.cs` + +DO NOT TRUST THIS CLIENT ID AND SECRET! THIS IS ONLY FOR TESTING PURPOSES!! + +The limitation with this developer application is that this will not work with GitHub Enterprise. You will see sign-in will fail on the OAuth callback due to the credentials not being present there. + +To provide your own Client ID and Client Secret: - [Register a new developer application](https://github.com/settings/developers) in your profile. - Copy [common/ApplicationInfo_Local.cs-example](../../common/ApplicationInfo_Local.cs-example) to `common/ApplicationInfo_Local.cs` and fill out the clientId/clientSecret fields for your application. -The build needs to reference `UnityEngine.dll` and `UnityEditor.dll`. These DLLs are included with Unity. If you've installed Unity in the default location, the build will be able to find them automatically. If not, copy these DLLs from `[your Unity installation path]\Unity\Editor\Data\Managed` into the `lib` directory in order for the build to work. ### Visual Studio @@ -56,21 +69,14 @@ Once you've built the solution for the first time, you can open `src/UnityExtens The build also creates a Unity test project called `GitHubExtension` inside a directory called `github-unity-test` next to your local clone. For instance, if the repository is located at `c:\Projects\Unity` the test project will be at `c:\Projects\github-unity-test\GitHubExtension`. You can use this project to test binary builds of the extension in a clean environment (all needed DLLs will be copied to it every time you build). -Note: some files might be locked by Unity if have one of the build output projects open when you compile from VS or the command line. This is expected and shouldn't cause issues with your builds. +Note: some files might be locked by Unity if have one of the build output projects open when you compile from VS or the command line. This is expected and shouldn't cause issues with your builds. ## Solution organization The `GitHub.Unity.sln` solution includes several projects: -- dotnet-httpclient35 and octokit: external dependencies for threading and github api support, respectively. These are the submodules. - packaging: empty projects with build rules that copy DLLs to various locations for testing - Tests: unit and integration test projects - GitHub.Logging: A logging helper library - GitHub.Api: The core of the extension. This project is C#6 and includes async/await threading and other features that Unity cannot currently compile. - GitHub.Unity: Unity-specific code. This project is compilable by Unity - -## Other solutions - -Octokit is normally included as a prebuilt DLL (in the `lib` directory), but when updating Octokit or debugging issues with the 3.5 backport, it can sometimes be handy to reference the project directly. The `GitHub.Unity.OctokitDebugging.sln` solution is a helper solution that includes Octokit and dotnet-httpclient35 as referenced projects instead of prebuilt dlls. - -This solution requires a clone of [https://github.com/github-for-unity/octokit.net](https://github.com/github-for-unity/octokit.net) and [https://github.com/github-for-unity/dotnet-httpclient35](https://github.com/github-for-unity/dotnet-httpclient35) to exist next to your GitHub for Unity checkout. diff --git a/docs/process/roadmap.md b/docs/process/roadmap.md index e69de29bb..80a958e7f 100644 --- a/docs/process/roadmap.md +++ b/docs/process/roadmap.md @@ -0,0 +1,51 @@ +# The roadmap + +## The road to 1.0 + +### 1.0-RC ETA + +March 2018 + +### 1.0 ETA + +May 2018 + +### Feature list + +- Windows and Mac support + - Unity 5.4 and above +- Initialize new repository in existing project + - Configure yaml merge tool + - Configure project serialization for source control + - Configure git and lfs +- Publish to GitHub +- Authentication + - Login with user/password and 2FA if needed + - Invoked when doing git operations + - https support +- Local repository management + - List changed files + - Commit selectively + - Discard file changes +- Repository history and network operations + - List of commits + - Individual commit detail + - Revert commit + - List of local branches + - List of remote branches + - Create branch + - Delete branch + - Fetch + - Push + - Pull +- File locking + - Lock and unlock files + - Visual locking indicators in file UIs + - List locked files + - Notification when file is locked by someone else +- Git management + - User and email configuration + - Git remote configuration + - Git installation path configuration +- Misc + - Notification of new releases diff --git a/docs/readme.md b/docs/readme.md index a95adb7e9..d73e8e840 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -28,7 +28,10 @@ Details about how the team is organizing and shipping GitHub for Unity: - **[Roadmap](process/roadmap.md)** - how we plan for the future - **[Release](process/release-process.md)** - how we review contributions -## Technical +## Using -These documents contain more details about the internals of GitHub for Unity -and how things work: +[Quick Guide](using/quick-guide.md) + +These documents contain more details on how to use the GitHub for Unity plugin: +- **[Installing and Updating the GitHub for Unity package](using/how-to-install-and-update.md)** +- **[Getting Started with the GitHub for Unity package](using/getting-started.md)** diff --git a/docs/using/authenticating-to-github.md b/docs/using/authenticating-to-github.md new file mode 100644 index 000000000..203a3473d --- /dev/null +++ b/docs/using/authenticating-to-github.md @@ -0,0 +1,37 @@ +# Authenticating to GitHub + +## How to sign in to GitHub + +1. Open the **GitHub** window by going to the top level **Window** menu and selecting **GitHub**, as shown below. + + GitHub menu item in the Window menu + +1. Click the **Sign in** button at the top right of the window. + + GitHub menu item in the Window menu + +1. In the **Authenticate** dialog, enter your username or email and password + + GitHub menu item in the Window menu + + If your account requires Two Factor Authentication, you will be prompted for your auth code. + + GitHub menu item in the Window menu + +You will need to create a GitHub account before you can sign in, if you don't have one already. + +- For more information on creating a GitHub account, see "[Signing up for a new GitHub account](https://help.github.com/articles/signing-up-for-a-new-github-account/)". + +### Personal access tokens + +If the sign in operation above fails, you can manually create a personal access token and use it as your password. + +The scopes for the personal access token are: `user`, `repo`. +- *user* scope: Grants access to the user profile data. We currently use this to display your avatar and check whether your plans lets you publish private repositories. +- *repo* scope: Grants read/write access to code, commit statuses, invitations, collaborators, adding team memberships, and deployment statuses for public and private repositories and organizations. This is needed for all git network operations (push, pull, fetch), and for getting information about the repository you're currently working on. + +***Note:*** *Some older versions of the plugin ask for `gist` and `write:public_key`.* + +For more information on creating personal access tokens, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line). + +For more information on authenticating with SAML single sign-on, see "[About authentication with SAML single sign-on](https://help.github.com/articles/about-authentication-with-saml-single-sign-on)." diff --git a/docs/using/getting-started.md b/docs/using/getting-started.md new file mode 100644 index 000000000..4c5892a96 --- /dev/null +++ b/docs/using/getting-started.md @@ -0,0 +1,28 @@ +# Getting Started with GitHub for Unity +There are often three states that you might be in when you are setting up your GitHub for Unity package with your Unity project: +- [Setting up a brand new repository](#setting-up-a-new-repository): You do not currently have your Unity project in a repository and you want to publish it to one. +- [Connecting to an existing respository](#connecting-to-an-existing-repository): Your Unity project is already in a repository, but you do not have the GitHub for Unity package installed within it yet. +- [Opening a Unity project that already has the GitHub for Unity package](#connecting-to-an-existing-repository-that-already-has-the-github-for-unity-package): Your Unity project is already in a repository and it already has the GitHub for Unity package and you are trying to setup a new machine. + +# Setting up a New Repository +If you have a Unity project (new or existing) that is not yet connected to any remote repository, you can use the GitHub for Unity package to quickly intialize the repository and publish to a repository. + +1. If your Unity project doesn't yet have the GitHub plugin installed, follow [these](https://github.com/github-for-unity/Unity/blob/master/docs/using/how-to-install-and-update.md) instructions for installing it. +2. Click on the `Initialize a git repository for this project` button +screen shot 2018-05-18 at 9 39 13 am +And you should see the GitHub spinner: +screen shot 2018-05-18 at 9 39 23 am +3. The GitHub tab should reload with the following buttons: + - Publish: Publish this repository to GitHub (Creating a new GitHub repository) + - Account: Login to your GitHub account | Logout from your GitHub account or visit your profile on GitHub.com + - Changes: Local changes that are not yet committed, with a dialog to commit those changes + - History: A history of commits with title, time stamp, and commit author + - Branches: A list of local and remote branches with the ability to create new branches, switch branches, or checkout remote branches + - Settings: your git configuration (pulled from your local git credentials if they have been previously set), your repository configuration (you can manually put the URL to any remote repository here instead of using the Publish button to publish to GitHub), a list of locked files, your git installation details, and general settings to help us better help you if you get stuck + +# Cloning an Existing Repository +GitHub for Unity does not have the functionality to clone projects (yet!). +1. Clone the repository (either through command line or with GitHub Desktop https://desktop.github.com/). +2. Open the project in Unity. +3. Install GitHub for Unity if it is not already installed. +4. The GitHub plugin should load with all functionality enabled. \ No newline at end of file diff --git a/docs/using/how-to-install-and-update.md b/docs/using/how-to-install-and-update.md new file mode 100644 index 000000000..fb9dd93d8 --- /dev/null +++ b/docs/using/how-to-install-and-update.md @@ -0,0 +1,51 @@ +# Installation and Updating Guide +[Installing from a Downloaded Package File](#installing-from-a-package-file) +[Installing from the Unity Asset Store](#installing-from-the-asset-store) +[Updating a Previously Installed Version](#updating-the-github-for-unity-package) + +_Note: If your Unity project already has the GitHub for Unity plugin installed, see our [Getting Started](https://github.com/github-for-unity/Unity/blob/master/docs/using/getting-started.md) docs before continuing_ + + +# Installing from a Package File +You can download the latest release from the repository at [https://github.com/github-for-unity/Unity/releases](https://github.com/github-for-unity/Unity/releases) or from the website at [https://unity.github.com/](https://unity.github.com/). + +Once you've downloaded the package file, you can quickly install it within Unity. +1. Open a new Unity Project +screen shot 2018-05-18 at 7 10 07 am +2. Go to `Assets -> Import Package -> Custom Package` +screen shot 2018-05-18 at 7 11 35 am +3. Find and open the GitHub for Unity Asset Package +screen shot 2018-05-18 at 7 12 33 am +4. Click `Import` when the dialog pops up +screen shot 2018-05-18 at 7 12 42 am +5. After the package finishes importing, go to `Window -> GitHub` to open the GitHub window +screen shot 2018-05-18 at 7 13 03 am +6. You should see the GitHub window in your Unity project, with a button to initialize your repository +screen shot 2018-05-18 at 7 13 34 am + +# Installing from the Asset Store +1. Open a new Unity Project +screen shot 2018-05-18 at 7 10 07 am +2. Go to `Window -> Asset Store` +screen shot 2018-05-18 at 7 20 19 am +3. Search for "GitHub" in the search bar +screen shot 2018-05-18 at 7 20 51 am +4. Click on the GitHub for Unity Package +screen shot 2018-05-18 at 7 22 15 am +5. Click `Download` then `Install` +screen shot 2018-05-18 at 7 21 37 am +screen shot 2018-05-18 at 7 21 44 am +6. Click `Import` when the dialog pops up +screen shot 2018-05-18 at 7 12 42 am +7. After the package finishes importing, go to `Window -> GitHub` to open the GitHub window +screen shot 2018-05-18 at 7 13 03 am +8. You should see the GitHub window in your Unity project, with a button to initialize your repository +screen shot 2018-05-18 at 7 13 34 am + +# Updating the GitHub for Unity Package + +- If you are running Unity and wish to update GitHub for Unity (unless explicitly stated), be sure that the files in `x64` and `x86` are not selected. + + ![image](https://user-images.githubusercontent.com/417571/44666907-6e6d5a80-a9e7-11e8-8f97-b3b52250a75d.png) + +- Otherwise, it's best to stop Unity and delete GitHub for Unity from your project. Startup Unity and run the package installer like normal. Allowing it to restore everything. diff --git a/docs/using/images/branches-initial-view.png b/docs/using/images/branches-initial-view.png new file mode 100644 index 000000000..811bcf724 --- /dev/null +++ b/docs/using/images/branches-initial-view.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:558821e67ea26955434da0485785e9240b6c15c44a3790b642fdcd37382e56a2 +size 59798 diff --git a/docs/using/images/changes-view.png b/docs/using/images/changes-view.png new file mode 100644 index 000000000..23000f8ef --- /dev/null +++ b/docs/using/images/changes-view.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2ac4637a222a06e6ab57f23082b8e8b2f5cb9e35b9b99776c112ddcebb923dec +size 61918 diff --git a/docs/using/images/confirm-pull-changes.png b/docs/using/images/confirm-pull-changes.png new file mode 100644 index 000000000..722bbd639 --- /dev/null +++ b/docs/using/images/confirm-pull-changes.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4b0e1aa1d8d86cb0264c9ca569a5c8e71b0aba73a2eb6611c06ec47670037d7d +size 21478 diff --git a/docs/using/images/confirm-push-changes.png b/docs/using/images/confirm-push-changes.png new file mode 100644 index 000000000..ff1ca1cd0 --- /dev/null +++ b/docs/using/images/confirm-push-changes.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9e2e136027b03609f344bfde0c777d8e915544a5e9920f1268e4cc3abc5b1481 +size 18676 diff --git a/docs/using/images/confirm-revert.png b/docs/using/images/confirm-revert.png new file mode 100644 index 000000000..cbf5d1566 --- /dev/null +++ b/docs/using/images/confirm-revert.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ba990ce12403bfb53fb387ca3f3e2c447b21814ed6cd7e6f88d968463a5253a8 +size 21973 diff --git a/docs/using/images/create-new-branch-view.png b/docs/using/images/create-new-branch-view.png new file mode 100644 index 000000000..34c69d1ea --- /dev/null +++ b/docs/using/images/create-new-branch-view.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f0239a51f611501dc63c828de206f35d412493871f65e712983666e67dbfc231 +size 62046 diff --git a/docs/using/images/delete-dialog.png b/docs/using/images/delete-dialog.png new file mode 100644 index 000000000..574489f7c --- /dev/null +++ b/docs/using/images/delete-dialog.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:99d7cd8ef4957614cc844a08a632159157295414dc4675c1394f3209e30ffa58 +size 76315 diff --git a/docs/using/images/github-authenticate.png b/docs/using/images/github-authenticate.png new file mode 100644 index 000000000..188121d97 --- /dev/null +++ b/docs/using/images/github-authenticate.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:31ca0f7c4fc5c737a3db2da6eeb3deaa862d27e2cf3d1aa78fa14555b7cac750 +size 5927 diff --git a/docs/using/images/github-menu-item.png b/docs/using/images/github-menu-item.png new file mode 100644 index 000000000..44f3f9458 --- /dev/null +++ b/docs/using/images/github-menu-item.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c423766a70230c245f4bcdb1e33d9e76f267bf789876ecf9050016f9c8671735 +size 19651 diff --git a/docs/using/images/github-sign-in-button.png b/docs/using/images/github-sign-in-button.png new file mode 100644 index 000000000..cb6132c24 --- /dev/null +++ b/docs/using/images/github-sign-in-button.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:79bea09964bcf1964d4d1e1fb9712fe9fc67dc8ffe11f936534c9f2be63fd777 +size 9318 diff --git a/docs/using/images/github-two-factor.png b/docs/using/images/github-two-factor.png new file mode 100644 index 000000000..7a3286616 --- /dev/null +++ b/docs/using/images/github-two-factor.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:aba2174f780ea52a7cf7bbfd5144527bb7b29c3ce6a3200b6b6f8c69b2d6fb48 +size 9665 diff --git a/docs/using/images/locked-scene.png b/docs/using/images/locked-scene.png new file mode 100644 index 000000000..7a839141d --- /dev/null +++ b/docs/using/images/locked-scene.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bbc246b18cbd173c19f392fe7ab85bffb8a97a7616ef99e7e37496e307924e49 +size 51983 diff --git a/docs/using/images/locks-view-right-click.png b/docs/using/images/locks-view-right-click.png new file mode 100644 index 000000000..0ee14312c --- /dev/null +++ b/docs/using/images/locks-view-right-click.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:590dae09b3c029e48c3703d6c85a6774b062ebea46f11c2c062d97fedcb436df +size 27251 diff --git a/docs/using/images/locks-view.png b/docs/using/images/locks-view.png new file mode 100644 index 000000000..e8790d74e --- /dev/null +++ b/docs/using/images/locks-view.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:118f2b2e1bb82b598107eaa73db9a077374ff4f9601e47677eca7296353b1bc3 +size 23274 diff --git a/docs/using/images/name-branch.png b/docs/using/images/name-branch.png new file mode 100644 index 000000000..9926c06db --- /dev/null +++ b/docs/using/images/name-branch.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:08232fa5cfd41a41c8091197ac27f433fdfa865c4996388dd0c731ac75176442 +size 59599 diff --git a/docs/using/images/new-branch-created.png b/docs/using/images/new-branch-created.png new file mode 100644 index 000000000..2a37a9aeb --- /dev/null +++ b/docs/using/images/new-branch-created.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8543da247ee23364c15abec87e4e3de3e62b85a470e7d3d090ade18fb321072c +size 64045 diff --git a/docs/using/images/post-commit-view.png b/docs/using/images/post-commit-view.png new file mode 100644 index 000000000..81fc7d135 --- /dev/null +++ b/docs/using/images/post-commit-view.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:91e26123236bdd3e692ca7d30ff0d6477311fe739d8008ba19fd543ee3506176 +size 21345 diff --git a/docs/using/images/post-push-history-view.png b/docs/using/images/post-push-history-view.png new file mode 100644 index 000000000..0d2ed767a --- /dev/null +++ b/docs/using/images/post-push-history-view.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c0c2d5ccaddc88d3268e0d57f02229525240ecc71bded951e23171456560268b +size 22485 diff --git a/docs/using/images/pull-view.png b/docs/using/images/pull-view.png new file mode 100644 index 000000000..842ff9660 --- /dev/null +++ b/docs/using/images/pull-view.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:feb83a46ebdd34ff46db3a38e8829f5adec5b10824bf69a8c56c9ba6fbd603ff +size 25054 diff --git a/docs/using/images/push-view.png b/docs/using/images/push-view.png new file mode 100644 index 000000000..42bef651a --- /dev/null +++ b/docs/using/images/push-view.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ab87bae0916af3681b7528891a359c77597fa3ea57f13eb6924f1cbcf2f2ab7d +size 14581 diff --git a/docs/using/images/release-lock.png b/docs/using/images/release-lock.png new file mode 100644 index 000000000..545b81c8a --- /dev/null +++ b/docs/using/images/release-lock.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0f6e05a714d270016d1f8ad4e018a895ed2b023fe59bd34a28df8d315c065649 +size 140913 diff --git a/docs/using/images/request-lock.png b/docs/using/images/request-lock.png new file mode 100644 index 000000000..b877e1d8f --- /dev/null +++ b/docs/using/images/request-lock.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3f25877141bed2dcbdc4324edcbd802b6f216771e80de704f20dc99a3fdc718b +size 136078 diff --git a/docs/using/images/revert-commit.png b/docs/using/images/revert-commit.png new file mode 100644 index 000000000..daad75c8c --- /dev/null +++ b/docs/using/images/revert-commit.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b7711f428f3e04ea056c47b5d43109f3941761f4c286360d3616e0598d2d7b75 +size 26119 diff --git a/docs/using/images/revert.png b/docs/using/images/revert.png new file mode 100644 index 000000000..326071a28 --- /dev/null +++ b/docs/using/images/revert.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:dea7b36eec8e2d99e1906b6cbc9cd22f52d2db09cc1a0cf34563585720b6649d +size 25141 diff --git a/docs/using/images/success-pull-changes.png b/docs/using/images/success-pull-changes.png new file mode 100644 index 000000000..a246da405 --- /dev/null +++ b/docs/using/images/success-pull-changes.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e0407ab83ca311f319ff7feac0dac84b862935e2b50353ff82c067bdadf80e16 +size 16888 diff --git a/docs/using/images/success-push-changes.png b/docs/using/images/success-push-changes.png new file mode 100644 index 000000000..8fba1f506 --- /dev/null +++ b/docs/using/images/success-push-changes.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cfd290cb1e52b0acb5503642a3aaef164bf343735729325484e25d8b99293d7e +size 13262 diff --git a/docs/using/images/switch-confirmation.png b/docs/using/images/switch-confirmation.png new file mode 100644 index 000000000..92d623d6c --- /dev/null +++ b/docs/using/images/switch-confirmation.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4ed80f5cf2fab5fd256dd7cd093ad505c966edb95bdc5a15c3f1ace042bec7f6 +size 73947 diff --git a/docs/using/images/switch-or-delete.png b/docs/using/images/switch-or-delete.png new file mode 100644 index 000000000..deab6badf --- /dev/null +++ b/docs/using/images/switch-or-delete.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8c0d171b2e8f7e212f2446b416235c6232c57c9b4927cfa41891bffa1940ae9d +size 73828 diff --git a/docs/using/images/switched-branches.png b/docs/using/images/switched-branches.png new file mode 100644 index 000000000..c185d25c5 --- /dev/null +++ b/docs/using/images/switched-branches.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:542806a8dcc012cdfadadaf9cdab3cf4871bbbbee2c8d73834946df4ed249aec +size 64281 diff --git a/docs/using/locking-files.md b/docs/using/locking-files.md new file mode 100644 index 000000000..f90c8e7a3 --- /dev/null +++ b/docs/using/locking-files.md @@ -0,0 +1,30 @@ +# Locking files + +## Request locks + +From the Project tab, right-click on a file to open the context menu and select `Request Lock`. + + +An additional way to lock a file is by selecting it and going to `Assets` -> `Request Lock`. + +## View locks + +After requesting a lock, a lock icon appears in the bottom right-hand corner of the file. + + +A list of all locked files will appear in the **Locks** view in the GitHub tab. + + +## Release locks + +There are three ways to release locks: + +1. From the Project tab, right-click on the locked file to open the context menu and select the option to `Release Lock`. + + +2. From the GitHub tab under the **Locks** view, right-click to open the context menu and select to `Release Lock`. + + +3. Select the file to unlock and go to select the menu option `Assets` -> `Release Lock`. + +Note: There are also two options for how to release a lock on a file. Always choose the `Release Lock` option first. The `Release Lock (forced)` option can be used to remove someone else's lock. diff --git a/docs/using/managing-branches.md b/docs/using/managing-branches.md new file mode 100644 index 000000000..13fa9c1bd --- /dev/null +++ b/docs/using/managing-branches.md @@ -0,0 +1,38 @@ +# Managing branches + +Initial **Branches** view + +Post commit view + +## Create branch + +1. From the **Branches** view, click on `master` under local branches to enable the `New Branch` button and be able to create a new branch from master. +2. Click on `New Branch`. +Post commit view + +3. Enter a name for the branch and click `Create`. +Post commit view + +4. The new branch will be created from master. +Post commit view + +## Checkout branch + +1. Right-click on a local branch and select `Switch` or double-click on the branch to switch to it. +Post commit view + +2. A dialog will appear asking `Switch branch to 'branch name'?`. Select `Switch`. +Post commit view + +The branch will be checked out. +Post commit view + +## Delete branches + +1. Click on the branch name to be deleted and the `Delete` button becomes enabled. +2. Right-click on a local branch and select `Delete` or click the `Delete` button above the Local branches list. +Post commit view + +3. A dialog appears asking `Are you sure you want to delete the branch: 'branch name'?`. Select `Delete`. + +The branch will be deleted. diff --git a/docs/using/quick-guide.md b/docs/using/quick-guide.md new file mode 100644 index 000000000..2011ee40f --- /dev/null +++ b/docs/using/quick-guide.md @@ -0,0 +1,164 @@ +# Quick Guide + +## More resources + +These documents contain more details on how to use the GitHub for Unity plugin: +- **[Installing and Updating the GitHub for Unity package](https://github.com/github-for-unity/Unity/blob/master/docs/using/how-to-install-and-update.md)** +- **[Getting Started with the GitHub for Unity package](https://github.com/github-for-unity/Unity/blob/master/docs/using/getting-started.md)** +- **[Authenticating to GitHub](https://github.com/github-for-unity/Unity/blob/master/docs/using/authenticating-to-github.md)** +- **[Managing Branches](https://github.com/github-for-unity/Unity/blob/master/docs/using/managing-branches.md)** +- **[Locking Files](https://github.com/github-for-unity/Unity/blob/master/docs/using/locking-files.md)** +- **[Working with Changes](https://github.com/github-for-unity/Unity/blob/master/docs/using/working-with-changes.md)** +- **[Using the Api](https://github.com/github-for-unity/Unity/blob/master/docs/using/using-the-api.md)** + +## Table of Contents + +[Installing GitHub for Unity](#installing-github-for-unity) + +- [Requirements](#requirements) + - [Git on macOS](#git-on-macos) + - [Git on Windows](#git-on-windows) +- [Installation](#installation) +- [Log files](#log-files) + - [Windows](#windows) + - [macOS](#macos) + +[Quick Guide to GitHub for Unity](#quick-guide-to-github-for-unity) + +- [Opening the GitHub window](#opening-the-github-window) +- [Initialize Repository](#initialize-repository) +- [Authentication](#authentication) +- [Publish a new repository](#publish-a-new-repository) +- [Commiting your work - Changes tab](#commiting-your-work---changes-tab) +- [Pushing/pulling your work - History tab](#pushingpulling-your-work---history-tab) +- [Branches tab](#branches-tab) +- [Settings tab](#settings-tab) + +## Installing GitHub for Unity + +### Requirements + +- Unity 5.4 or higher + - There's currently a blocker issue opened for 5.3 support, so we know it doesn't run there. Personal edition is fine. +- Git and Git LFS 2.x + +#### Git on macOS + +The current release has limited macOS support. macOS users will need to install the latest [Git](https://git-scm.com/downloads) and [Git LFS](https://git-lfs.github.com/) manually, and make sure these are on the path. You can configure the Git location in the `Settings` tab on the GitHub window. + +The easiest way of installing git and git lfs is to install [Homebrew](https://brew.sh/) and then do `brew install git git-lfs`. + +Make sure a Git user and email address are set in the `~/.gitconfig` file before you initialize a repository for the first time. You can set these values by opening your `~/.gitconfig` file and adding the following section, if it doesn't exist yet: + +``` +[user] + name = Your Name + email = Your Email +``` + +#### Git on Windows + +The GitHub for Unity extension ships with a bundle of Git and Git LFS, to ensure that you have the correct version. These will be installed into `%LOCALAPPDATA%\GitHubUnity` when the extension runs for the first time. + +Make sure a Git user and email address are set in the `%HOME%\.gitconfig` file before you initialize a repository for the first time. You can set these values by opening your `%HOME%\.gitconfig` file and adding the following section, if it doesn't exist yet: + +``` +[user] + name = Your Name + email = Your Email +``` + +Once the extension is installed, you can open a command line with the same Git and Git LFS version that the extension uses by going to `Window` -> `GitHub Command Line` in Unity. + +### Installation + +This extensions needs to be installed (and updated) for each Unity project that you want to version control. +First step is to download the latest package from [the releases page](https://github.com/github-for-unity/Unity/releases); it will be saved as a file with the extension `.unitypackage`. +To install it, open Unity, then open the project you want to version control, and then double click on the downloaded package. +Alternatively, import the package by clicking `Assets`, `Import Package`, `Custom Package`, then select the downloaded package. + +#### Log files + +##### macOS + +The extension log file can be found at `~/Library/Logs/GitHubUnity/github-unity.log` + +##### Windows + +The extension log file can be found at `%LOCALAPPDATA%\GitHubUnity\github-unity.log` + +## I have a problem with GitHub for Unity + +First, please search the [open issues](https://github.com/github-for-unity/Unity/issues?q=is%3Aopen) +and [closed issues](https://github.com/github-for-unity/Unity/issues?q=is%3Aclosed) +to see if your issue hasn't already been reported (it may also be fixed). + +If you can't find an issue that matches what you're seeing, open a [new issue](https://github.com/github-for-unity/Unity/issues/new) +and fill out the template to provide us with enough information to investigate +further. + +## Quick Guide to GitHub for Unity + +### Opening the GitHub window + +You can access the GitHub window by going to `Windows` -> `GitHub`. The window opens by default next to the Inspector window. + +### Initialize Repository + +![Initialize repository screenshot](https://user-images.githubusercontent.com/10103121/37807041-bb4446a6-2e19-11e8-9fff-a431309b8515.png) + +If the current Unity project is not in a Git repository, the GitHub for Unity extension will offer to initialize the repository for you. This will: + +- Initialize a git repository at the Unity project root via `git init` +- Initialize git-lfs via `git lfs install` +- Set up a `.gitignore` file at the Unity project root. +- Set up a `.gitattributes` file at the Unity project root with a large list of known binary filetypes (images, audio, etc) that should be tracked by LFS +- Configure the project to serialize meta files as text +- Create an initial commit with the `.gitignore` and `.gitattributes` file. + +### Authentication + +To set up credentials in Git so you can push and pull, you can sign in to GitHub by going to `Window` -> `GitHub` -> `Account` -> `Sign in`. You only have to sign in successfully once, your credentials will remain on the system for all Git operations in Unity and outside of it. If you've already signed in once but the Account dropdown still says `Sign in`, ignore it, it's a bug. + +![Authentication screenshot](https://user-images.githubusercontent.com/121322/27644895-8f22f904-5bd9-11e7-8a93-e6bfe0c24a74.png) + +For more information on Authentication: - **[Authenticating to GitHub](https://github.com/github-for-unity/Unity/blob/master/docs/using/authenticating-to-github.md)** + +### Publish a new repository + +1. Go to [github.com](https://github.com) and create a new empty repository - do not add a license, readme or other files during the creation process. +2. Copy the **https** URL shown in the creation page +3. In Unity, go to `Windows` -> `GitHub` -> `Settings` and paste the url into the `Remote` textbox. +4. Click `Save repository`. +5. Go to the `History` tab and click `Push`. + +### Commiting your work - Changes tab + +You can see which files have been changed and commit them through the `Changes` tab. `.meta` files will show up in relation to their files on the tree, so you can select a file for comitting and automatically have their `.meta` + +![Changes tab screenshot](https://user-images.githubusercontent.com/121322/27644933-ab00af72-5bd9-11e7-84c3-edec495f87f5.png) + +For more information on working with changes: - **[Working with Changes](https://github.com/github-for-unity/Unity/blob/master/docs/using/working-with-changes.md#commit-changes)** + +### Pushing/pulling your work - History tab + +The history tab includes a `Push` button to push your work to the server. Make sure you have a remote url configured in the `Settings` tab so that you can push and pull your work. + +To receive updates from the server by clicking on the `Pull` button. You cannot pull if you have local changes, so commit your changes before pulling. + +![History tab screenshot](https://user-images.githubusercontent.com/121322/27644965-c1109bba-5bd9-11e7-9257-4fa38f5c67d1.png) + + +For more information on working with changes: - **[Working with Changes](https://github.com/github-for-unity/Unity/blob/master/docs/using/working-with-changes.md#pulling-changes)** + +### Branches tab + +![Branches tab screenshot](https://user-images.githubusercontent.com/121322/27644978-cd3c5622-5bd9-11e7-9dcb-6ae5d5c7dc8a.png) + +### Settings tab + +You can configure your user data in the `Settings` tab, along with the path to the Git installation. + +Locked files will appear in a list in the Settings tab. You can see who has locked a file and release file locks after you've pushed your work. + +![Settings tab screenshot](https://user-images.githubusercontent.com/121322/27644993-d9d325a0-5bd9-11e7-86f5-beee00e9e8b8.png) diff --git a/docs/using/using-the-api.md b/docs/using/using-the-api.md new file mode 100644 index 000000000..ab75cab55 --- /dev/null +++ b/docs/using/using-the-api.md @@ -0,0 +1,75 @@ +# Using the API + +GitHub for Unity provides access to a git client to help users create their own tools to assist in their workflow. + +Users can separate the user interface from the API by removing `GitHub.Unity.dll`. All other libraries are required by the API. + +## Creating an instance of `GitClient` +```cs +var defaultEnvironment = new DefaultEnvironment(); +defaultEnvironment.Initialize(null, NPath.Default, NPath.Default, NPath.Default, Application.dataPath.ToNPath()); + +var processEnvironment = new ProcessEnvironment(defaultEnvironment); +var processManager = new ProcessManager(defaultEnvironment, processEnvironment, TaskManager.Instance.Token); + +var gitClient = new GitClient(defaultEnvironment, processManager, TaskManager.Instance.Token); +``` + +## Full Example +This example creates a window that has a single button which commits all changes. +```cs +using System; +using System.Globalization; +using GitHub.Unity; +using UnityEditor; +using UnityEngine; + +public class CustomGitEditor : EditorWindow +{ + [MenuItem("Window/Custom Git")] + public static void ShowWindow() + { + EditorWindow.GetWindow(typeof(CustomGitEditor)); + } + + [NonSerialized] private GitClient gitClient; + + public void OnEnable() + { + InitGitClient(); + } + + private void InitGitClient() + { + if (gitClient != null) return; + + Debug.Log("Init GitClient"); + + var defaultEnvironment = new DefaultEnvironment(); + defaultEnvironment.Initialize(null, NPath.Default, NPath.Default, + NPath.Default, Application.dataPath.ToNPath()); + + var processEnvironment = new ProcessEnvironment(defaultEnvironment); + var processManager = new ProcessManager(defaultEnvironment, processEnvironment, TaskManager.Instance.Token); + + gitClient = new GitClient(defaultEnvironment, processManager, TaskManager.Instance.Token); + } + + void OnGUI() + { + GUILayout.Label("Custom Git Window", EditorStyles.boldLabel); + + if (GUILayout.Button("Commit Stuff")) + { + var message = DateTime.Now.ToString(CultureInfo.InvariantCulture); + var body = string.Empty; + + gitClient.AddAll() + .Then(gitClient.Commit(message, body)) + .Start(); + } + } +} +``` + + diff --git a/docs/using/working-with-changes.md b/docs/using/working-with-changes.md new file mode 100644 index 000000000..228e4bd3f --- /dev/null +++ b/docs/using/working-with-changes.md @@ -0,0 +1,53 @@ +# Working with changes + +## Commit changes + +All changes made to a repository will show up under the **Changes** view. + +1. Select the changes to be committed. Can choose the All/None options, or select directories or files individually. +2. Enter a Commit summary which describes the purpose of the commit. An optional Commit description can also be entered. +3. Click the button `Commit to [branch name]`. +Changes view + +The commit will not be shown under the **History** view. On the top bar the button `Push (1)` indicates that there is 1 commit to push. + +Post commit view + +## Push changes to GitHub + +1. Click `Push` once ready to push a commit to GitHub. +Push view + +2. A dialog will appear asking `Would you like to push changes to remote 'branch name'?` Select `Push`. +Confirm push dialog + +3. Another dialog will appear when the push to GitHub is complete saying `Branch pushed`. Select `ok`. +Branch pushed + +## Revert changes + +1. From the **History** view, right-click on a commit in the commit list. A `Revert` option will appear. +2. Click `Revert`. +Revert + +3. A dialog will appear asking `Are you sure you want to revert the following commit: "commit message"?`. Select `Revert`. +Confirm revert dialog + +4. A new commit appears titled `Revert "commit summary"` and the view indicates that there is 1 commit to push. +Revert commit + +5. Follow the steps to push the reverted commit to GitHub. + +## Pulling changes + +1. Click the `Fetch` button to get all the latest branches and tags for the repository. The `Pull` button will then show the number of commits to pull from GitHub. +2. Click `Pull`. +Pull changes + +3. A dialog will appear asking `Would you like to pull changes from remote 'branch name'?`. Select `Pull`. +Confirm pull changes dialog + +4. Another dialog appears saying `Local branch is up to date with 'branch name'`. Select `ok`. +Changes pulled + + diff --git a/EULA.txt b/eula.txt similarity index 100% rename from EULA.txt rename to eula.txt diff --git a/generate-package.sh b/generate-package.sh new file mode 100755 index 000000000..e9ef73a4a --- /dev/null +++ b/generate-package.sh @@ -0,0 +1,91 @@ +#!/bin/sh -eu +DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" + +URL="http://ghfvs-installer.github.com" +GIT=0 +LFS=0 +GHU=0 +FILE="" +VERSION="" +RN="" +MSG="" +OS="" + +while [[ $# -gt 0 ]] +do +key="$1" + +case $key in + -h) + URL="$2" + shift + shift + ;; + -p) + FILE="--path $2" + shift + shift + ;; + -v) + VERSION="--version $2" + shift + shift + ;; + -r) + RN="--rn $2" + shift + shift + ;; + -m) + MSG="--msg $2" + shift + shift + ;; + -git) + GIT=1 + shift # past value + ;; + -lfs) + LFS=1 + shift # past value + ;; + -ghu) + GHU=1 + shift # past value + ;; + -windows) + OS="windows" + shift # past value + ;; + -mac) + OS="mac" + shift # past value + ;; + -linux) + OS="linux" + shift # past value + ;; +esac +done + +if [ x"$GIT" = "x0" -a x"$LFS" = "x0" -a x"$GHU" = "x0" ]; then + echo "Usage: generate-package.sh [-git|-lfs|-ghu] [-windows|-mac|-linux only if -git or -lfs] [-v version] [-p path to file] [-h host url (optional)] [-r release notes file (optional)] [-m message file (optional)]" + exit 1 +fi + +if [ x"$GHU" = x"1" ]; then + URL="--url $URL/unity/releases" +else + URL="--url $URL/unity/git/$OS" +fi + +EXEC= +if [ ! -e "/c/" ]; then + EXEC=mono +fi + +if [ ! -e "build/CommandLine/CommandLine.exe" ]; then + >&2 xbuild /target:CommandLine "$DIR/GitHub.Unity.sln" /verbosity:minimal +fi + +$EXEC build/CommandLine/CommandLine.exe --gen-package $VERSION $FILE $URL $RN $MSG diff --git a/lib/.gitignore b/lib/.gitignore index 1ea843a1c..9432a8bee 100644 --- a/lib/.gitignore +++ b/lib/.gitignore @@ -1 +1,2 @@ -Unity* \ No newline at end of file +Managed +UnityExtensions \ No newline at end of file diff --git a/lib/ICSharpCode.NRefactory.dll b/lib/ICSharpCode.NRefactory.dll deleted file mode 100644 index f11688c6c..000000000 --- a/lib/ICSharpCode.NRefactory.dll +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:2e28e35172498877c7e4a33253b0c5df172bce5655b2ab933a922d6777ae5e6d -size 528384 diff --git a/lib/ICSharpCode.SharpZipLib.dll b/lib/ICSharpCode.SharpZipLib.dll deleted file mode 100644 index 108abfd2a..000000000 --- a/lib/ICSharpCode.SharpZipLib.dll +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:fbace48694fbfff69ff99ff7aefbde67965f7723092df9c13ff537d2a319f410 -size 192000 diff --git a/src/GitHub.Api/PlatformResources/linux/.placeholder b/lib/Managed/.gitignore similarity index 100% rename from src/GitHub.Api/PlatformResources/linux/.placeholder rename to lib/Managed/.gitignore diff --git a/lib/Mono.Security.dll b/lib/Mono.Security.dll deleted file mode 100644 index a7a97c141..000000000 --- a/lib/Mono.Security.dll +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:71ba4944619044e35abf7970e23e9c6b87acd2700dcae8d6655f39c53bcf40e1 -size 294912 diff --git a/lib/TunnelVisionLabs.Threading.2.0.0-unity.nupkg b/lib/TunnelVisionLabs.Threading.2.0.0-unity.nupkg deleted file mode 100644 index 24376117f..000000000 Binary files a/lib/TunnelVisionLabs.Threading.2.0.0-unity.nupkg and /dev/null differ diff --git a/lib/TunnelVisionLabs.Threading.2.0.0-unity.symbols.nupkg b/lib/TunnelVisionLabs.Threading.2.0.0-unity.symbols.nupkg deleted file mode 100644 index e652c34b2..000000000 Binary files a/lib/TunnelVisionLabs.Threading.2.0.0-unity.symbols.nupkg and /dev/null differ diff --git a/lib/UnityExtensions/Unity/TestRunner/Editor/.gitignore b/lib/UnityExtensions/Unity/TestRunner/Editor/.gitignore new file mode 100644 index 000000000..e69de29bb diff --git a/lib/dotnet-httpClient35/System.Net.Http.dll b/lib/dotnet-httpClient35/System.Net.Http.dll deleted file mode 100644 index 69fee1021..000000000 --- a/lib/dotnet-httpClient35/System.Net.Http.dll +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:5fd1e590c79fa453c5722bd645ef037d5f7748177bab14bd794981adc11a06a0 -size 123904 diff --git a/lib/dotnet-httpClient35/System.Net.Http.dll.mdb b/lib/dotnet-httpClient35/System.Net.Http.dll.mdb deleted file mode 100644 index 5f13b0ccb..000000000 --- a/lib/dotnet-httpClient35/System.Net.Http.dll.mdb +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:df057b70add2c6488614a273236cb07d5b971026de36c5b9a3f044a547af75f2 -size 47752 diff --git a/lib/dotnet-httpClient35/md5sums.txt b/lib/dotnet-httpClient35/md5sums.txt deleted file mode 100644 index e99ef3233..000000000 --- a/lib/dotnet-httpClient35/md5sums.txt +++ /dev/null @@ -1,2 +0,0 @@ -e15a0894ef162ec53566fa9c8211e583 *System.Net.Http.dll -161847a9a61eb3cdab7a7706e83265a1 *System.Net.Http.dll.mdb diff --git a/lib/dotnet-httpClient35/version.txt b/lib/dotnet-httpClient35/version.txt deleted file mode 100644 index 38dcf35fb..000000000 --- a/lib/dotnet-httpClient35/version.txt +++ /dev/null @@ -1 +0,0 @@ -3.5.0.0 3.5.22000.2-gfu 43d89b670547006521c95fc150d9b79506c208ca \ No newline at end of file diff --git a/lib/octokit.net/Octokit.dll b/lib/octokit.net/Octokit.dll deleted file mode 100644 index 9ecfd9fce..000000000 --- a/lib/octokit.net/Octokit.dll +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:003fb61b6517b43d4ce412070bede800af20a161bcf8cb9cbcbac38aed1075da -size 741888 diff --git a/lib/octokit.net/Octokit.dll.mdb b/lib/octokit.net/Octokit.dll.mdb deleted file mode 100644 index 041f8dd04..000000000 --- a/lib/octokit.net/Octokit.dll.mdb +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:fe50d2c5d38b8dd9407a9053f46b4cec638959637d690ff169cf7aea2db4a187 -size 288546 diff --git a/lib/octokit.net/md5sums.txt b/lib/octokit.net/md5sums.txt deleted file mode 100644 index 60441e277..000000000 --- a/lib/octokit.net/md5sums.txt +++ /dev/null @@ -1,2 +0,0 @@ -ecb6930236469c41a36dee6d84fcab7a *Octokit.dll -2a41d96c1ad9229d8ff2f46b8847ec6a *Octokit.dll.mdb diff --git a/lib/octokit.net/version.txt b/lib/octokit.net/version.txt deleted file mode 100644 index 1024bde64..000000000 --- a/lib/octokit.net/version.txt +++ /dev/null @@ -1 +0,0 @@ -0.23.0.1 0.23.0.2-gfu 9784094cdd6192887dc97180918565c036c6b62c \ No newline at end of file diff --git a/lib/pdb2mdb.exe b/lib/pdb2mdb.exe new file mode 100644 index 000000000..72547bf3c --- /dev/null +++ b/lib/pdb2mdb.exe @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a72425f98bdb5923704946c4010485d471ce9e35611264f394637fb185424619 +size 369664 diff --git a/nuget.config b/nuget.config index 1a5bd9cf3..bad252e01 100644 --- a/nuget.config +++ b/nuget.config @@ -1,7 +1,7 @@ - + diff --git a/octorun/.env.template b/octorun/.env.template new file mode 100644 index 000000000..a42e21c4a --- /dev/null +++ b/octorun/.env.template @@ -0,0 +1,5 @@ +OCTOKIT_CLIENT_ID= +OCTOKIT_CLIENT_SECRET= +OCTOKIT_USER_AGENT= +OCTORUN_USER= +OCTORUN_TOKEN= \ No newline at end of file diff --git a/octorun/.gitignore b/octorun/.gitignore new file mode 100644 index 000000000..ef4fcce9d --- /dev/null +++ b/octorun/.gitignore @@ -0,0 +1,3 @@ +.env +node_modules +npm-debug.log diff --git a/octorun/bin/octorun b/octorun/bin/octorun new file mode 100644 index 000000000..b6623d43e --- /dev/null +++ b/octorun/bin/octorun @@ -0,0 +1,3 @@ +#!/usr/bin/env node + +require('../src/bin/app.js'); diff --git a/octorun/bin/octorun-login b/octorun/bin/octorun-login new file mode 100644 index 000000000..f74f2b860 --- /dev/null +++ b/octorun/bin/octorun-login @@ -0,0 +1,3 @@ +#!/usr/bin/env node + +require('../src/bin/app-login.js'); diff --git a/octorun/bin/octorun-meta b/octorun/bin/octorun-meta new file mode 100644 index 000000000..1d2d3a7c9 --- /dev/null +++ b/octorun/bin/octorun-meta @@ -0,0 +1,3 @@ +#!/usr/bin/env node + +require('../src/bin/app-meta.js'); diff --git a/octorun/bin/octorun-organizations b/octorun/bin/octorun-organizations new file mode 100644 index 000000000..bf6c9f558 --- /dev/null +++ b/octorun/bin/octorun-organizations @@ -0,0 +1,3 @@ +#!/usr/bin/env node + +require('../src/bin/app-organizations.js'); diff --git a/octorun/bin/octorun-publish b/octorun/bin/octorun-publish new file mode 100644 index 000000000..c95bdbb44 --- /dev/null +++ b/octorun/bin/octorun-publish @@ -0,0 +1,3 @@ +#!/usr/bin/env node + +require('../src/bin/app-publish.js'); diff --git a/octorun/bin/octorun-token b/octorun/bin/octorun-token new file mode 100644 index 000000000..3ea7b1500 --- /dev/null +++ b/octorun/bin/octorun-token @@ -0,0 +1,3 @@ +#!/usr/bin/env node + +require('../src/bin/app-token.js'); diff --git a/octorun/bin/octorun-usage b/octorun/bin/octorun-usage new file mode 100644 index 000000000..8366ae34e --- /dev/null +++ b/octorun/bin/octorun-usage @@ -0,0 +1,3 @@ +#!/usr/bin/env node + +require('../src/bin/app-usage.js'); diff --git a/octorun/bin/octorun-validate b/octorun/bin/octorun-validate new file mode 100644 index 000000000..e81615852 --- /dev/null +++ b/octorun/bin/octorun-validate @@ -0,0 +1,3 @@ +#!/usr/bin/env node + +require('../src/bin/app-validate.js'); diff --git a/octorun/node_modules/commander/CHANGELOG.md b/octorun/node_modules/commander/CHANGELOG.md new file mode 100644 index 000000000..29f0707c6 --- /dev/null +++ b/octorun/node_modules/commander/CHANGELOG.md @@ -0,0 +1,350 @@ + +2.14.1 / 2018-02-07 +================== + + * Fix typing of help function + +2.14.0 / 2018-02-05 +================== + + * only register the option:version event once + * Fixes issue #727: Passing empty string for option on command is set to undefined + * enable eqeqeq rule + * resolves #754 add linter configuration to project + * resolves #560 respect custom name for version option + * document how to override the version flag + * document using options per command + +2.13.0 / 2018-01-09 +================== + + * Do not print default for --no- + * remove trailing spaces in command help + * Update CI's Node.js to LTS and latest version + * typedefs: Command and Option types added to commander namespace + +2.12.2 / 2017-11-28 +================== + + * fix: typings are not shipped + +2.12.1 / 2017-11-23 +================== + + * Move @types/node to dev dependency + +2.12.0 / 2017-11-22 +================== + + * add attributeName() method to Option objects + * Documentation updated for options with --no prefix + * typings: `outputHelp` takes a string as the first parameter + * typings: use overloads + * feat(typings): update to match js api + * Print default value in option help + * Fix translation error + * Fail when using same command and alias (#491) + * feat(typings): add help callback + * fix bug when description is add after command with options (#662) + * Format js code + * Rename History.md to CHANGELOG.md (#668) + * feat(typings): add typings to support TypeScript (#646) + * use current node + +2.11.0 / 2017-07-03 +================== + + * Fix help section order and padding (#652) + * feature: support for signals to subcommands (#632) + * Fixed #37, --help should not display first (#447) + * Fix translation errors. (#570) + * Add package-lock.json + * Remove engines + * Upgrade package version + * Prefix events to prevent conflicts between commands and options (#494) + * Removing dependency on graceful-readlink + * Support setting name in #name function and make it chainable + * Add .vscode directory to .gitignore (Visual Studio Code metadata) + * Updated link to ruby commander in readme files + +2.10.0 / 2017-06-19 +================== + + * Update .travis.yml. drop support for older node.js versions. + * Fix require arguments in README.md + * On SemVer you do not start from 0.0.1 + * Add missing semi colon in readme + * Add save param to npm install + * node v6 travis test + * Update Readme_zh-CN.md + * Allow literal '--' to be passed-through as an argument + * Test subcommand alias help + * link build badge to master branch + * Support the alias of Git style sub-command + * added keyword commander for better search result on npm + * Fix Sub-Subcommands + * test node.js stable + * Fixes TypeError when a command has an option called `--description` + * Update README.md to make it beginner friendly and elaborate on the difference between angled and square brackets. + * Add chinese Readme file + +2.9.0 / 2015-10-13 +================== + + * Add option `isDefault` to set default subcommand #415 @Qix- + * Add callback to allow filtering or post-processing of help text #434 @djulien + * Fix `undefined` text in help information close #414 #416 @zhiyelee + +2.8.1 / 2015-04-22 +================== + + * Back out `support multiline description` Close #396 #397 + +2.8.0 / 2015-04-07 +================== + + * Add `process.execArg` support, execution args like `--harmony` will be passed to sub-commands #387 @DigitalIO @zhiyelee + * Fix bug in Git-style sub-commands #372 @zhiyelee + * Allow commands to be hidden from help #383 @tonylukasavage + * When git-style sub-commands are in use, yet none are called, display help #382 @claylo + * Add ability to specify arguments syntax for top-level command #258 @rrthomas + * Support multiline descriptions #208 @zxqfox + +2.7.1 / 2015-03-11 +================== + + * Revert #347 (fix collisions when option and first arg have same name) which causes a bug in #367. + +2.7.0 / 2015-03-09 +================== + + * Fix git-style bug when installed globally. Close #335 #349 @zhiyelee + * Fix collisions when option and first arg have same name. Close #346 #347 @tonylukasavage + * Add support for camelCase on `opts()`. Close #353 @nkzawa + * Add node.js 0.12 and io.js to travis.yml + * Allow RegEx options. #337 @palanik + * Fixes exit code when sub-command failing. Close #260 #332 @pirelenito + * git-style `bin` files in $PATH make sense. Close #196 #327 @zhiyelee + +2.6.0 / 2014-12-30 +================== + + * added `Command#allowUnknownOption` method. Close #138 #318 @doozr @zhiyelee + * Add application description to the help msg. Close #112 @dalssoft + +2.5.1 / 2014-12-15 +================== + + * fixed two bugs incurred by variadic arguments. Close #291 @Quentin01 #302 @zhiyelee + +2.5.0 / 2014-10-24 +================== + + * add support for variadic arguments. Closes #277 @whitlockjc + +2.4.0 / 2014-10-17 +================== + + * fixed a bug on executing the coercion function of subcommands option. Closes #270 + * added `Command.prototype.name` to retrieve command name. Closes #264 #266 @tonylukasavage + * added `Command.prototype.opts` to retrieve all the options as a simple object of key-value pairs. Closes #262 @tonylukasavage + * fixed a bug on subcommand name. Closes #248 @jonathandelgado + * fixed function normalize doesn’t honor option terminator. Closes #216 @abbr + +2.3.0 / 2014-07-16 +================== + + * add command alias'. Closes PR #210 + * fix: Typos. Closes #99 + * fix: Unused fs module. Closes #217 + +2.2.0 / 2014-03-29 +================== + + * add passing of previous option value + * fix: support subcommands on windows. Closes #142 + * Now the defaultValue passed as the second argument of the coercion function. + +2.1.0 / 2013-11-21 +================== + + * add: allow cflag style option params, unit test, fixes #174 + +2.0.0 / 2013-07-18 +================== + + * remove input methods (.prompt, .confirm, etc) + +1.3.2 / 2013-07-18 +================== + + * add support for sub-commands to co-exist with the original command + +1.3.1 / 2013-07-18 +================== + + * add quick .runningCommand hack so you can opt-out of other logic when running a sub command + +1.3.0 / 2013-07-09 +================== + + * add EACCES error handling + * fix sub-command --help + +1.2.0 / 2013-06-13 +================== + + * allow "-" hyphen as an option argument + * support for RegExp coercion + +1.1.1 / 2012-11-20 +================== + + * add more sub-command padding + * fix .usage() when args are present. Closes #106 + +1.1.0 / 2012-11-16 +================== + + * add git-style executable subcommand support. Closes #94 + +1.0.5 / 2012-10-09 +================== + + * fix `--name` clobbering. Closes #92 + * fix examples/help. Closes #89 + +1.0.4 / 2012-09-03 +================== + + * add `outputHelp()` method. + +1.0.3 / 2012-08-30 +================== + + * remove invalid .version() defaulting + +1.0.2 / 2012-08-24 +================== + + * add `--foo=bar` support [arv] + * fix password on node 0.8.8. Make backward compatible with 0.6 [focusaurus] + +1.0.1 / 2012-08-03 +================== + + * fix issue #56 + * fix tty.setRawMode(mode) was moved to tty.ReadStream#setRawMode() (i.e. process.stdin.setRawMode()) + +1.0.0 / 2012-07-05 +================== + + * add support for optional option descriptions + * add defaulting of `.version()` to package.json's version + +0.6.1 / 2012-06-01 +================== + + * Added: append (yes or no) on confirmation + * Added: allow node.js v0.7.x + +0.6.0 / 2012-04-10 +================== + + * Added `.prompt(obj, callback)` support. Closes #49 + * Added default support to .choose(). Closes #41 + * Fixed the choice example + +0.5.1 / 2011-12-20 +================== + + * Fixed `password()` for recent nodes. Closes #36 + +0.5.0 / 2011-12-04 +================== + + * Added sub-command option support [itay] + +0.4.3 / 2011-12-04 +================== + + * Fixed custom help ordering. Closes #32 + +0.4.2 / 2011-11-24 +================== + + * Added travis support + * Fixed: line-buffered input automatically trimmed. Closes #31 + +0.4.1 / 2011-11-18 +================== + + * Removed listening for "close" on --help + +0.4.0 / 2011-11-15 +================== + + * Added support for `--`. Closes #24 + +0.3.3 / 2011-11-14 +================== + + * Fixed: wait for close event when writing help info [Jerry Hamlet] + +0.3.2 / 2011-11-01 +================== + + * Fixed long flag definitions with values [felixge] + +0.3.1 / 2011-10-31 +================== + + * Changed `--version` short flag to `-V` from `-v` + * Changed `.version()` so it's configurable [felixge] + +0.3.0 / 2011-10-31 +================== + + * Added support for long flags only. Closes #18 + +0.2.1 / 2011-10-24 +================== + + * "node": ">= 0.4.x < 0.7.0". Closes #20 + +0.2.0 / 2011-09-26 +================== + + * Allow for defaults that are not just boolean. Default peassignment only occurs for --no-*, optional, and required arguments. [Jim Isaacs] + +0.1.0 / 2011-08-24 +================== + + * Added support for custom `--help` output + +0.0.5 / 2011-08-18 +================== + + * Changed: when the user enters nothing prompt for password again + * Fixed issue with passwords beginning with numbers [NuckChorris] + +0.0.4 / 2011-08-15 +================== + + * Fixed `Commander#args` + +0.0.3 / 2011-08-15 +================== + + * Added default option value support + +0.0.2 / 2011-08-15 +================== + + * Added mask support to `Command#password(str[, mask], fn)` + * Added `Command#password(str, fn)` + +0.0.1 / 2010-01-03 +================== + + * Initial release diff --git a/octorun/node_modules/commander/LICENSE b/octorun/node_modules/commander/LICENSE new file mode 100644 index 000000000..10f997ab1 --- /dev/null +++ b/octorun/node_modules/commander/LICENSE @@ -0,0 +1,22 @@ +(The MIT License) + +Copyright (c) 2011 TJ Holowaychuk + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +'Software'), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/octorun/node_modules/commander/Readme.md b/octorun/node_modules/commander/Readme.md new file mode 100644 index 000000000..6a21b9009 --- /dev/null +++ b/octorun/node_modules/commander/Readme.md @@ -0,0 +1,408 @@ +# Commander.js + + +[![Build Status](https://api.travis-ci.org/tj/commander.js.svg?branch=master)](http://travis-ci.org/tj/commander.js) +[![NPM Version](http://img.shields.io/npm/v/commander.svg?style=flat)](https://www.npmjs.org/package/commander) +[![NPM Downloads](https://img.shields.io/npm/dm/commander.svg?style=flat)](https://www.npmjs.org/package/commander) +[![Join the chat at https://gitter.im/tj/commander.js](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/tj/commander.js?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) + + The complete solution for [node.js](http://nodejs.org) command-line interfaces, inspired by Ruby's [commander](https://github.com/commander-rb/commander). + [API documentation](http://tj.github.com/commander.js/) + + +## Installation + + $ npm install commander --save + +## Option parsing + +Options with commander are defined with the `.option()` method, also serving as documentation for the options. The example below parses args and options from `process.argv`, leaving remaining args as the `program.args` array which were not consumed by options. + +```js +#!/usr/bin/env node + +/** + * Module dependencies. + */ + +var program = require('commander'); + +program + .version('0.1.0') + .option('-p, --peppers', 'Add peppers') + .option('-P, --pineapple', 'Add pineapple') + .option('-b, --bbq-sauce', 'Add bbq sauce') + .option('-c, --cheese [type]', 'Add the specified type of cheese [marble]', 'marble') + .parse(process.argv); + +console.log('you ordered a pizza with:'); +if (program.peppers) console.log(' - peppers'); +if (program.pineapple) console.log(' - pineapple'); +if (program.bbqSauce) console.log(' - bbq'); +console.log(' - %s cheese', program.cheese); +``` + +Short flags may be passed as a single arg, for example `-abc` is equivalent to `-a -b -c`. Multi-word options such as "--template-engine" are camel-cased, becoming `program.templateEngine` etc. + +Note that multi-word options starting with `--no` prefix negate the boolean value of the following word. For example, `--no-sauce` sets the value of `program.sauce` to false. + +```js +#!/usr/bin/env node + +/** + * Module dependencies. + */ + +var program = require('commander'); + +program + .option('--no-sauce', 'Remove sauce') + .parse(process.argv); + +console.log('you ordered a pizza'); +if (program.sauce) console.log(' with sauce'); +else console.log(' without sauce'); +``` + +## Version option + +Calling the `version` implicitly adds the `-V` and `--version` options to the command. +When either of these options is present, the command prints the version number and exits. + + $ ./examples/pizza -V + 0.0.1 + +If you want your program to respond to the `-v` option instead of the `-V` option, simply pass custom flags to the `version` method using the same syntax as the `option` method. + +```js +program + .version('0.0.1', '-v, --version') +``` + +The version flags can be named anything, but the long option is required. + +## Command-specific options + +You can attach options to a command. + +```js +#!/usr/bin/env node + +var program = require('commander'); + +program + .command('rm ') + .option('-r, --recursive', 'Remove recursively') + .action(function (dir, cmd) { + console.log('remove ' + dir + (cmd.recursive ? ' recursively' : '')) + }) + +program.parse(process.argv) +``` + +A command's options are validated when the command is used. Any unknown options will be reported as an error. However, if an action-based command does not define an action, then the options are not validated. + +## Coercion + +```js +function range(val) { + return val.split('..').map(Number); +} + +function list(val) { + return val.split(','); +} + +function collect(val, memo) { + memo.push(val); + return memo; +} + +function increaseVerbosity(v, total) { + return total + 1; +} + +program + .version('0.1.0') + .usage('[options] ') + .option('-i, --integer ', 'An integer argument', parseInt) + .option('-f, --float ', 'A float argument', parseFloat) + .option('-r, --range ..', 'A range', range) + .option('-l, --list ', 'A list', list) + .option('-o, --optional [value]', 'An optional value') + .option('-c, --collect [value]', 'A repeatable value', collect, []) + .option('-v, --verbose', 'A value that can be increased', increaseVerbosity, 0) + .parse(process.argv); + +console.log(' int: %j', program.integer); +console.log(' float: %j', program.float); +console.log(' optional: %j', program.optional); +program.range = program.range || []; +console.log(' range: %j..%j', program.range[0], program.range[1]); +console.log(' list: %j', program.list); +console.log(' collect: %j', program.collect); +console.log(' verbosity: %j', program.verbose); +console.log(' args: %j', program.args); +``` + +## Regular Expression +```js +program + .version('0.1.0') + .option('-s --size ', 'Pizza size', /^(large|medium|small)$/i, 'medium') + .option('-d --drink [drink]', 'Drink', /^(coke|pepsi|izze)$/i) + .parse(process.argv); + +console.log(' size: %j', program.size); +console.log(' drink: %j', program.drink); +``` + +## Variadic arguments + + The last argument of a command can be variadic, and only the last argument. To make an argument variadic you have to + append `...` to the argument name. Here is an example: + +```js +#!/usr/bin/env node + +/** + * Module dependencies. + */ + +var program = require('commander'); + +program + .version('0.1.0') + .command('rmdir [otherDirs...]') + .action(function (dir, otherDirs) { + console.log('rmdir %s', dir); + if (otherDirs) { + otherDirs.forEach(function (oDir) { + console.log('rmdir %s', oDir); + }); + } + }); + +program.parse(process.argv); +``` + + An `Array` is used for the value of a variadic argument. This applies to `program.args` as well as the argument passed + to your action as demonstrated above. + +## Specify the argument syntax + +```js +#!/usr/bin/env node + +var program = require('commander'); + +program + .version('0.1.0') + .arguments(' [env]') + .action(function (cmd, env) { + cmdValue = cmd; + envValue = env; + }); + +program.parse(process.argv); + +if (typeof cmdValue === 'undefined') { + console.error('no command given!'); + process.exit(1); +} +console.log('command:', cmdValue); +console.log('environment:', envValue || "no environment given"); +``` +Angled brackets (e.g. ``) indicate required input. Square brackets (e.g. `[env]`) indicate optional input. + +## Git-style sub-commands + +```js +// file: ./examples/pm +var program = require('commander'); + +program + .version('0.1.0') + .command('install [name]', 'install one or more packages') + .command('search [query]', 'search with optional query') + .command('list', 'list packages installed', {isDefault: true}) + .parse(process.argv); +``` + +When `.command()` is invoked with a description argument, no `.action(callback)` should be called to handle sub-commands, otherwise there will be an error. This tells commander that you're going to use separate executables for sub-commands, much like `git(1)` and other popular tools. +The commander will try to search the executables in the directory of the entry script (like `./examples/pm`) with the name `program-command`, like `pm-install`, `pm-search`. + +Options can be passed with the call to `.command()`. Specifying `true` for `opts.noHelp` will remove the option from the generated help output. Specifying `true` for `opts.isDefault` will run the subcommand if no other subcommand is specified. + +If the program is designed to be installed globally, make sure the executables have proper modes, like `755`. + +### `--harmony` + +You can enable `--harmony` option in two ways: +* Use `#! /usr/bin/env node --harmony` in the sub-commands scripts. Note some os version don’t support this pattern. +* Use the `--harmony` option when call the command, like `node --harmony examples/pm publish`. The `--harmony` option will be preserved when spawning sub-command process. + +## Automated --help + + The help information is auto-generated based on the information commander already knows about your program, so the following `--help` info is for free: + +``` + $ ./examples/pizza --help + + Usage: pizza [options] + + An application for pizzas ordering + + Options: + + -h, --help output usage information + -V, --version output the version number + -p, --peppers Add peppers + -P, --pineapple Add pineapple + -b, --bbq Add bbq sauce + -c, --cheese Add the specified type of cheese [marble] + -C, --no-cheese You do not want any cheese + +``` + +## Custom help + + You can display arbitrary `-h, --help` information + by listening for "--help". Commander will automatically + exit once you are done so that the remainder of your program + does not execute causing undesired behaviours, for example + in the following executable "stuff" will not output when + `--help` is used. + +```js +#!/usr/bin/env node + +/** + * Module dependencies. + */ + +var program = require('commander'); + +program + .version('0.1.0') + .option('-f, --foo', 'enable some foo') + .option('-b, --bar', 'enable some bar') + .option('-B, --baz', 'enable some baz'); + +// must be before .parse() since +// node's emit() is immediate + +program.on('--help', function(){ + console.log(' Examples:'); + console.log(''); + console.log(' $ custom-help --help'); + console.log(' $ custom-help -h'); + console.log(''); +}); + +program.parse(process.argv); + +console.log('stuff'); +``` + +Yields the following help output when `node script-name.js -h` or `node script-name.js --help` are run: + +``` + +Usage: custom-help [options] + +Options: + + -h, --help output usage information + -V, --version output the version number + -f, --foo enable some foo + -b, --bar enable some bar + -B, --baz enable some baz + +Examples: + + $ custom-help --help + $ custom-help -h + +``` + +## .outputHelp(cb) + +Output help information without exiting. +Optional callback cb allows post-processing of help text before it is displayed. + +If you want to display help by default (e.g. if no command was provided), you can use something like: + +```js +var program = require('commander'); +var colors = require('colors'); + +program + .version('0.1.0') + .command('getstream [url]', 'get stream URL') + .parse(process.argv); + +if (!process.argv.slice(2).length) { + program.outputHelp(make_red); +} + +function make_red(txt) { + return colors.red(txt); //display the help text in red on the console +} +``` + +## .help(cb) + + Output help information and exit immediately. + Optional callback cb allows post-processing of help text before it is displayed. + +## Examples + +```js +var program = require('commander'); + +program + .version('0.1.0') + .option('-C, --chdir ', 'change the working directory') + .option('-c, --config ', 'set config path. defaults to ./deploy.conf') + .option('-T, --no-tests', 'ignore test hook'); + +program + .command('setup [env]') + .description('run setup commands for all envs') + .option("-s, --setup_mode [mode]", "Which setup mode to use") + .action(function(env, options){ + var mode = options.setup_mode || "normal"; + env = env || 'all'; + console.log('setup for %s env(s) with %s mode', env, mode); + }); + +program + .command('exec ') + .alias('ex') + .description('execute the given remote cmd') + .option("-e, --exec_mode ", "Which exec mode to use") + .action(function(cmd, options){ + console.log('exec "%s" using %s mode', cmd, options.exec_mode); + }).on('--help', function() { + console.log(' Examples:'); + console.log(); + console.log(' $ deploy exec sequential'); + console.log(' $ deploy exec async'); + console.log(); + }); + +program + .command('*') + .action(function(env){ + console.log('deploying "%s"', env); + }); + +program.parse(process.argv); +``` + +More Demos can be found in the [examples](https://github.com/tj/commander.js/tree/master/examples) directory. + +## License + +MIT diff --git a/octorun/node_modules/commander/index.js b/octorun/node_modules/commander/index.js new file mode 100644 index 000000000..c467b10f7 --- /dev/null +++ b/octorun/node_modules/commander/index.js @@ -0,0 +1,1157 @@ +/** + * Module dependencies. + */ + +var EventEmitter = require('events').EventEmitter; +var spawn = require('child_process').spawn; +var path = require('path'); +var dirname = path.dirname; +var basename = path.basename; +var fs = require('fs'); + +/** + * Inherit `Command` from `EventEmitter.prototype`. + */ + +require('util').inherits(Command, EventEmitter); + +/** + * Expose the root command. + */ + +exports = module.exports = new Command(); + +/** + * Expose `Command`. + */ + +exports.Command = Command; + +/** + * Expose `Option`. + */ + +exports.Option = Option; + +/** + * Initialize a new `Option` with the given `flags` and `description`. + * + * @param {String} flags + * @param {String} description + * @api public + */ + +function Option(flags, description) { + this.flags = flags; + this.required = ~flags.indexOf('<'); + this.optional = ~flags.indexOf('['); + this.bool = !~flags.indexOf('-no-'); + flags = flags.split(/[ ,|]+/); + if (flags.length > 1 && !/^[[<]/.test(flags[1])) this.short = flags.shift(); + this.long = flags.shift(); + this.description = description || ''; +} + +/** + * Return option name. + * + * @return {String} + * @api private + */ + +Option.prototype.name = function() { + return this.long + .replace('--', '') + .replace('no-', ''); +}; + +/** + * Return option name, in a camelcase format that can be used + * as a object attribute key. + * + * @return {String} + * @api private + */ + +Option.prototype.attributeName = function() { + return camelcase(this.name()); +}; + +/** + * Check if `arg` matches the short or long flag. + * + * @param {String} arg + * @return {Boolean} + * @api private + */ + +Option.prototype.is = function(arg) { + return this.short === arg || this.long === arg; +}; + +/** + * Initialize a new `Command`. + * + * @param {String} name + * @api public + */ + +function Command(name) { + this.commands = []; + this.options = []; + this._execs = {}; + this._allowUnknownOption = false; + this._args = []; + this._name = name || ''; +} + +/** + * Add command `name`. + * + * The `.action()` callback is invoked when the + * command `name` is specified via __ARGV__, + * and the remaining arguments are applied to the + * function for access. + * + * When the `name` is "*" an un-matched command + * will be passed as the first arg, followed by + * the rest of __ARGV__ remaining. + * + * Examples: + * + * program + * .version('0.0.1') + * .option('-C, --chdir ', 'change the working directory') + * .option('-c, --config ', 'set config path. defaults to ./deploy.conf') + * .option('-T, --no-tests', 'ignore test hook') + * + * program + * .command('setup') + * .description('run remote setup commands') + * .action(function() { + * console.log('setup'); + * }); + * + * program + * .command('exec ') + * .description('run the given remote command') + * .action(function(cmd) { + * console.log('exec "%s"', cmd); + * }); + * + * program + * .command('teardown [otherDirs...]') + * .description('run teardown commands') + * .action(function(dir, otherDirs) { + * console.log('dir "%s"', dir); + * if (otherDirs) { + * otherDirs.forEach(function (oDir) { + * console.log('dir "%s"', oDir); + * }); + * } + * }); + * + * program + * .command('*') + * .description('deploy the given env') + * .action(function(env) { + * console.log('deploying "%s"', env); + * }); + * + * program.parse(process.argv); + * + * @param {String} name + * @param {String} [desc] for git-style sub-commands + * @return {Command} the new command + * @api public + */ + +Command.prototype.command = function(name, desc, opts) { + if (typeof desc === 'object' && desc !== null) { + opts = desc; + desc = null; + } + opts = opts || {}; + var args = name.split(/ +/); + var cmd = new Command(args.shift()); + + if (desc) { + cmd.description(desc); + this.executables = true; + this._execs[cmd._name] = true; + if (opts.isDefault) this.defaultExecutable = cmd._name; + } + cmd._noHelp = !!opts.noHelp; + this.commands.push(cmd); + cmd.parseExpectedArgs(args); + cmd.parent = this; + + if (desc) return this; + return cmd; +}; + +/** + * Define argument syntax for the top-level command. + * + * @api public + */ + +Command.prototype.arguments = function(desc) { + return this.parseExpectedArgs(desc.split(/ +/)); +}; + +/** + * Add an implicit `help [cmd]` subcommand + * which invokes `--help` for the given command. + * + * @api private + */ + +Command.prototype.addImplicitHelpCommand = function() { + this.command('help [cmd]', 'display help for [cmd]'); +}; + +/** + * Parse expected `args`. + * + * For example `["[type]"]` becomes `[{ required: false, name: 'type' }]`. + * + * @param {Array} args + * @return {Command} for chaining + * @api public + */ + +Command.prototype.parseExpectedArgs = function(args) { + if (!args.length) return; + var self = this; + args.forEach(function(arg) { + var argDetails = { + required: false, + name: '', + variadic: false + }; + + switch (arg[0]) { + case '<': + argDetails.required = true; + argDetails.name = arg.slice(1, -1); + break; + case '[': + argDetails.name = arg.slice(1, -1); + break; + } + + if (argDetails.name.length > 3 && argDetails.name.slice(-3) === '...') { + argDetails.variadic = true; + argDetails.name = argDetails.name.slice(0, -3); + } + if (argDetails.name) { + self._args.push(argDetails); + } + }); + return this; +}; + +/** + * Register callback `fn` for the command. + * + * Examples: + * + * program + * .command('help') + * .description('display verbose help') + * .action(function() { + * // output help here + * }); + * + * @param {Function} fn + * @return {Command} for chaining + * @api public + */ + +Command.prototype.action = function(fn) { + var self = this; + var listener = function(args, unknown) { + // Parse any so-far unknown options + args = args || []; + unknown = unknown || []; + + var parsed = self.parseOptions(unknown); + + // Output help if necessary + outputHelpIfNecessary(self, parsed.unknown); + + // If there are still any unknown options, then we simply + // die, unless someone asked for help, in which case we give it + // to them, and then we die. + if (parsed.unknown.length > 0) { + self.unknownOption(parsed.unknown[0]); + } + + // Leftover arguments need to be pushed back. Fixes issue #56 + if (parsed.args.length) args = parsed.args.concat(args); + + self._args.forEach(function(arg, i) { + if (arg.required && args[i] == null) { + self.missingArgument(arg.name); + } else if (arg.variadic) { + if (i !== self._args.length - 1) { + self.variadicArgNotLast(arg.name); + } + + args[i] = args.splice(i); + } + }); + + // Always append ourselves to the end of the arguments, + // to make sure we match the number of arguments the user + // expects + if (self._args.length) { + args[self._args.length] = self; + } else { + args.push(self); + } + + fn.apply(self, args); + }; + var parent = this.parent || this; + var name = parent === this ? '*' : this._name; + parent.on('command:' + name, listener); + if (this._alias) parent.on('command:' + this._alias, listener); + return this; +}; + +/** + * Define option with `flags`, `description` and optional + * coercion `fn`. + * + * The `flags` string should contain both the short and long flags, + * separated by comma, a pipe or space. The following are all valid + * all will output this way when `--help` is used. + * + * "-p, --pepper" + * "-p|--pepper" + * "-p --pepper" + * + * Examples: + * + * // simple boolean defaulting to false + * program.option('-p, --pepper', 'add pepper'); + * + * --pepper + * program.pepper + * // => Boolean + * + * // simple boolean defaulting to true + * program.option('-C, --no-cheese', 'remove cheese'); + * + * program.cheese + * // => true + * + * --no-cheese + * program.cheese + * // => false + * + * // required argument + * program.option('-C, --chdir ', 'change the working directory'); + * + * --chdir /tmp + * program.chdir + * // => "/tmp" + * + * // optional argument + * program.option('-c, --cheese [type]', 'add cheese [marble]'); + * + * @param {String} flags + * @param {String} description + * @param {Function|*} [fn] or default + * @param {*} [defaultValue] + * @return {Command} for chaining + * @api public + */ + +Command.prototype.option = function(flags, description, fn, defaultValue) { + var self = this, + option = new Option(flags, description), + oname = option.name(), + name = option.attributeName(); + + // default as 3rd arg + if (typeof fn !== 'function') { + if (fn instanceof RegExp) { + var regex = fn; + fn = function(val, def) { + var m = regex.exec(val); + return m ? m[0] : def; + }; + } else { + defaultValue = fn; + fn = null; + } + } + + // preassign default value only for --no-*, [optional], or + if (!option.bool || option.optional || option.required) { + // when --no-* we make sure default is true + if (!option.bool) defaultValue = true; + // preassign only if we have a default + if (defaultValue !== undefined) { + self[name] = defaultValue; + option.defaultValue = defaultValue; + } + } + + // register the option + this.options.push(option); + + // when it's passed assign the value + // and conditionally invoke the callback + this.on('option:' + oname, function(val) { + // coercion + if (val !== null && fn) { + val = fn(val, self[name] === undefined ? defaultValue : self[name]); + } + + // unassigned or bool + if (typeof self[name] === 'boolean' || typeof self[name] === 'undefined') { + // if no value, bool true, and we have a default, then use it! + if (val == null) { + self[name] = option.bool + ? defaultValue || true + : false; + } else { + self[name] = val; + } + } else if (val !== null) { + // reassign + self[name] = val; + } + }); + + return this; +}; + +/** + * Allow unknown options on the command line. + * + * @param {Boolean} arg if `true` or omitted, no error will be thrown + * for unknown options. + * @api public + */ +Command.prototype.allowUnknownOption = function(arg) { + this._allowUnknownOption = arguments.length === 0 || arg; + return this; +}; + +/** + * Parse `argv`, settings options and invoking commands when defined. + * + * @param {Array} argv + * @return {Command} for chaining + * @api public + */ + +Command.prototype.parse = function(argv) { + // implicit help + if (this.executables) this.addImplicitHelpCommand(); + + // store raw args + this.rawArgs = argv; + + // guess name + this._name = this._name || basename(argv[1], '.js'); + + // github-style sub-commands with no sub-command + if (this.executables && argv.length < 3 && !this.defaultExecutable) { + // this user needs help + argv.push('--help'); + } + + // process argv + var parsed = this.parseOptions(this.normalize(argv.slice(2))); + var args = this.args = parsed.args; + + var result = this.parseArgs(this.args, parsed.unknown); + + // executable sub-commands + var name = result.args[0]; + + var aliasCommand = null; + // check alias of sub commands + if (name) { + aliasCommand = this.commands.filter(function(command) { + return command.alias() === name; + })[0]; + } + + if (this._execs[name] && typeof this._execs[name] !== 'function') { + return this.executeSubCommand(argv, args, parsed.unknown); + } else if (aliasCommand) { + // is alias of a subCommand + args[0] = aliasCommand._name; + return this.executeSubCommand(argv, args, parsed.unknown); + } else if (this.defaultExecutable) { + // use the default subcommand + args.unshift(this.defaultExecutable); + return this.executeSubCommand(argv, args, parsed.unknown); + } + + return result; +}; + +/** + * Execute a sub-command executable. + * + * @param {Array} argv + * @param {Array} args + * @param {Array} unknown + * @api private + */ + +Command.prototype.executeSubCommand = function(argv, args, unknown) { + args = args.concat(unknown); + + if (!args.length) this.help(); + if (args[0] === 'help' && args.length === 1) this.help(); + + // --help + if (args[0] === 'help') { + args[0] = args[1]; + args[1] = '--help'; + } + + // executable + var f = argv[1]; + // name of the subcommand, link `pm-install` + var bin = basename(f, '.js') + '-' + args[0]; + + // In case of globally installed, get the base dir where executable + // subcommand file should be located at + var baseDir, + link = fs.lstatSync(f).isSymbolicLink() ? fs.readlinkSync(f) : f; + + // when symbolink is relative path + if (link !== f && link.charAt(0) !== '/') { + link = path.join(dirname(f), link); + } + baseDir = dirname(link); + + // prefer local `./` to bin in the $PATH + var localBin = path.join(baseDir, bin); + + // whether bin file is a js script with explicit `.js` extension + var isExplicitJS = false; + if (exists(localBin + '.js')) { + bin = localBin + '.js'; + isExplicitJS = true; + } else if (exists(localBin)) { + bin = localBin; + } + + args = args.slice(1); + + var proc; + if (process.platform !== 'win32') { + if (isExplicitJS) { + args.unshift(bin); + // add executable arguments to spawn + args = (process.execArgv || []).concat(args); + + proc = spawn(process.argv[0], args, { stdio: 'inherit', customFds: [0, 1, 2] }); + } else { + proc = spawn(bin, args, { stdio: 'inherit', customFds: [0, 1, 2] }); + } + } else { + args.unshift(bin); + proc = spawn(process.execPath, args, { stdio: 'inherit' }); + } + + var signals = ['SIGUSR1', 'SIGUSR2', 'SIGTERM', 'SIGINT', 'SIGHUP']; + signals.forEach(function(signal) { + process.on(signal, function() { + if (proc.killed === false && proc.exitCode === null) { + proc.kill(signal); + } + }); + }); + proc.on('close', process.exit.bind(process)); + proc.on('error', function(err) { + if (err.code === 'ENOENT') { + console.error('\n %s(1) does not exist, try --help\n', bin); + } else if (err.code === 'EACCES') { + console.error('\n %s(1) not executable. try chmod or run with root\n', bin); + } + process.exit(1); + }); + + // Store the reference to the child process + this.runningCommand = proc; +}; + +/** + * Normalize `args`, splitting joined short flags. For example + * the arg "-abc" is equivalent to "-a -b -c". + * This also normalizes equal sign and splits "--abc=def" into "--abc def". + * + * @param {Array} args + * @return {Array} + * @api private + */ + +Command.prototype.normalize = function(args) { + var ret = [], + arg, + lastOpt, + index; + + for (var i = 0, len = args.length; i < len; ++i) { + arg = args[i]; + if (i > 0) { + lastOpt = this.optionFor(args[i - 1]); + } + + if (arg === '--') { + // Honor option terminator + ret = ret.concat(args.slice(i)); + break; + } else if (lastOpt && lastOpt.required) { + ret.push(arg); + } else if (arg.length > 1 && arg[0] === '-' && arg[1] !== '-') { + arg.slice(1).split('').forEach(function(c) { + ret.push('-' + c); + }); + } else if (/^--/.test(arg) && ~(index = arg.indexOf('='))) { + ret.push(arg.slice(0, index), arg.slice(index + 1)); + } else { + ret.push(arg); + } + } + + return ret; +}; + +/** + * Parse command `args`. + * + * When listener(s) are available those + * callbacks are invoked, otherwise the "*" + * event is emitted and those actions are invoked. + * + * @param {Array} args + * @return {Command} for chaining + * @api private + */ + +Command.prototype.parseArgs = function(args, unknown) { + var name; + + if (args.length) { + name = args[0]; + if (this.listeners('command:' + name).length) { + this.emit('command:' + args.shift(), args, unknown); + } else { + this.emit('command:*', args); + } + } else { + outputHelpIfNecessary(this, unknown); + + // If there were no args and we have unknown options, + // then they are extraneous and we need to error. + if (unknown.length > 0) { + this.unknownOption(unknown[0]); + } + } + + return this; +}; + +/** + * Return an option matching `arg` if any. + * + * @param {String} arg + * @return {Option} + * @api private + */ + +Command.prototype.optionFor = function(arg) { + for (var i = 0, len = this.options.length; i < len; ++i) { + if (this.options[i].is(arg)) { + return this.options[i]; + } + } +}; + +/** + * Parse options from `argv` returning `argv` + * void of these options. + * + * @param {Array} argv + * @return {Array} + * @api public + */ + +Command.prototype.parseOptions = function(argv) { + var args = [], + len = argv.length, + literal, + option, + arg; + + var unknownOptions = []; + + // parse options + for (var i = 0; i < len; ++i) { + arg = argv[i]; + + // literal args after -- + if (literal) { + args.push(arg); + continue; + } + + if (arg === '--') { + literal = true; + continue; + } + + // find matching Option + option = this.optionFor(arg); + + // option is defined + if (option) { + // requires arg + if (option.required) { + arg = argv[++i]; + if (arg == null) return this.optionMissingArgument(option); + this.emit('option:' + option.name(), arg); + // optional arg + } else if (option.optional) { + arg = argv[i + 1]; + if (arg == null || (arg[0] === '-' && arg !== '-')) { + arg = null; + } else { + ++i; + } + this.emit('option:' + option.name(), arg); + // bool + } else { + this.emit('option:' + option.name()); + } + continue; + } + + // looks like an option + if (arg.length > 1 && arg[0] === '-') { + unknownOptions.push(arg); + + // If the next argument looks like it might be + // an argument for this option, we pass it on. + // If it isn't, then it'll simply be ignored + if ((i + 1) < argv.length && argv[i + 1][0] !== '-') { + unknownOptions.push(argv[++i]); + } + continue; + } + + // arg + args.push(arg); + } + + return { args: args, unknown: unknownOptions }; +}; + +/** + * Return an object containing options as key-value pairs + * + * @return {Object} + * @api public + */ +Command.prototype.opts = function() { + var result = {}, + len = this.options.length; + + for (var i = 0; i < len; i++) { + var key = this.options[i].attributeName(); + result[key] = key === this._versionOptionName ? this._version : this[key]; + } + return result; +}; + +/** + * Argument `name` is missing. + * + * @param {String} name + * @api private + */ + +Command.prototype.missingArgument = function(name) { + console.error(); + console.error(" error: missing required argument `%s'", name); + console.error(); + process.exit(1); +}; + +/** + * `Option` is missing an argument, but received `flag` or nothing. + * + * @param {String} option + * @param {String} flag + * @api private + */ + +Command.prototype.optionMissingArgument = function(option, flag) { + console.error(); + if (flag) { + console.error(" error: option `%s' argument missing, got `%s'", option.flags, flag); + } else { + console.error(" error: option `%s' argument missing", option.flags); + } + console.error(); + process.exit(1); +}; + +/** + * Unknown option `flag`. + * + * @param {String} flag + * @api private + */ + +Command.prototype.unknownOption = function(flag) { + if (this._allowUnknownOption) return; + console.error(); + console.error(" error: unknown option `%s'", flag); + console.error(); + process.exit(1); +}; + +/** + * Variadic argument with `name` is not the last argument as required. + * + * @param {String} name + * @api private + */ + +Command.prototype.variadicArgNotLast = function(name) { + console.error(); + console.error(" error: variadic arguments must be last `%s'", name); + console.error(); + process.exit(1); +}; + +/** + * Set the program version to `str`. + * + * This method auto-registers the "-V, --version" flag + * which will print the version number when passed. + * + * @param {String} str + * @param {String} [flags] + * @return {Command} for chaining + * @api public + */ + +Command.prototype.version = function(str, flags) { + if (arguments.length === 0) return this._version; + this._version = str; + flags = flags || '-V, --version'; + var versionOption = new Option(flags, 'output the version number'); + this._versionOptionName = versionOption.long.substr(2) || 'version'; + this.options.push(versionOption); + this.on('option:' + this._versionOptionName, function() { + process.stdout.write(str + '\n'); + process.exit(0); + }); + return this; +}; + +/** + * Set the description to `str`. + * + * @param {String} str + * @return {String|Command} + * @api public + */ + +Command.prototype.description = function(str) { + if (arguments.length === 0) return this._description; + this._description = str; + return this; +}; + +/** + * Set an alias for the command + * + * @param {String} alias + * @return {String|Command} + * @api public + */ + +Command.prototype.alias = function(alias) { + var command = this; + if (this.commands.length !== 0) { + command = this.commands[this.commands.length - 1]; + } + + if (arguments.length === 0) return command._alias; + + if (alias === command._name) throw new Error('Command alias can\'t be the same as its name'); + + command._alias = alias; + return this; +}; + +/** + * Set / get the command usage `str`. + * + * @param {String} str + * @return {String|Command} + * @api public + */ + +Command.prototype.usage = function(str) { + var args = this._args.map(function(arg) { + return humanReadableArgName(arg); + }); + + var usage = '[options]' + + (this.commands.length ? ' [command]' : '') + + (this._args.length ? ' ' + args.join(' ') : ''); + + if (arguments.length === 0) return this._usage || usage; + this._usage = str; + + return this; +}; + +/** + * Get or set the name of the command + * + * @param {String} str + * @return {String|Command} + * @api public + */ + +Command.prototype.name = function(str) { + if (arguments.length === 0) return this._name; + this._name = str; + return this; +}; + +/** + * Return the largest option length. + * + * @return {Number} + * @api private + */ + +Command.prototype.largestOptionLength = function() { + return this.options.reduce(function(max, option) { + return Math.max(max, option.flags.length); + }, 0); +}; + +/** + * Return help for options. + * + * @return {String} + * @api private + */ + +Command.prototype.optionHelp = function() { + var width = this.largestOptionLength(); + + // Append the help information + return this.options.map(function(option) { + return pad(option.flags, width) + ' ' + option.description + + ((option.bool && option.defaultValue !== undefined) ? ' (default: ' + option.defaultValue + ')' : ''); + }).concat([pad('-h, --help', width) + ' ' + 'output usage information']) + .join('\n'); +}; + +/** + * Return command help documentation. + * + * @return {String} + * @api private + */ + +Command.prototype.commandHelp = function() { + if (!this.commands.length) return ''; + + var commands = this.commands.filter(function(cmd) { + return !cmd._noHelp; + }).map(function(cmd) { + var args = cmd._args.map(function(arg) { + return humanReadableArgName(arg); + }).join(' '); + + return [ + cmd._name + + (cmd._alias ? '|' + cmd._alias : '') + + (cmd.options.length ? ' [options]' : '') + + (args ? ' ' + args : ''), + cmd._description + ]; + }); + + var width = commands.reduce(function(max, command) { + return Math.max(max, command[0].length); + }, 0); + + return [ + '', + ' Commands:', + '', + commands.map(function(cmd) { + var desc = cmd[1] ? ' ' + cmd[1] : ''; + return (desc ? pad(cmd[0], width) : cmd[0]) + desc; + }).join('\n').replace(/^/gm, ' '), + '' + ].join('\n'); +}; + +/** + * Return program help documentation. + * + * @return {String} + * @api private + */ + +Command.prototype.helpInformation = function() { + var desc = []; + if (this._description) { + desc = [ + ' ' + this._description, + '' + ]; + } + + var cmdName = this._name; + if (this._alias) { + cmdName = cmdName + '|' + this._alias; + } + var usage = [ + '', + ' Usage: ' + cmdName + ' ' + this.usage(), + '' + ]; + + var cmds = []; + var commandHelp = this.commandHelp(); + if (commandHelp) cmds = [commandHelp]; + + var options = [ + '', + ' Options:', + '', + '' + this.optionHelp().replace(/^/gm, ' '), + '' + ]; + + return usage + .concat(desc) + .concat(options) + .concat(cmds) + .join('\n'); +}; + +/** + * Output help information for this command + * + * @api public + */ + +Command.prototype.outputHelp = function(cb) { + if (!cb) { + cb = function(passthru) { + return passthru; + }; + } + process.stdout.write(cb(this.helpInformation())); + this.emit('--help'); +}; + +/** + * Output help information and exit. + * + * @api public + */ + +Command.prototype.help = function(cb) { + this.outputHelp(cb); + process.exit(); +}; + +/** + * Camel-case the given `flag` + * + * @param {String} flag + * @return {String} + * @api private + */ + +function camelcase(flag) { + return flag.split('-').reduce(function(str, word) { + return str + word[0].toUpperCase() + word.slice(1); + }); +} + +/** + * Pad `str` to `width`. + * + * @param {String} str + * @param {Number} width + * @return {String} + * @api private + */ + +function pad(str, width) { + var len = Math.max(0, width - str.length); + return str + Array(len + 1).join(' '); +} + +/** + * Output help information if necessary + * + * @param {Command} command to output help for + * @param {Array} array of options to search for -h or --help + * @api private + */ + +function outputHelpIfNecessary(cmd, options) { + options = options || []; + for (var i = 0; i < options.length; i++) { + if (options[i] === '--help' || options[i] === '-h') { + cmd.outputHelp(); + process.exit(0); + } + } +} + +/** + * Takes an argument an returns its human readable equivalent for help usage. + * + * @param {Object} arg + * @return {String} + * @api private + */ + +function humanReadableArgName(arg) { + var nameOutput = arg.name + (arg.variadic === true ? '...' : ''); + + return arg.required + ? '<' + nameOutput + '>' + : '[' + nameOutput + ']'; +} + +// for versions before node v0.8 when there weren't `fs.existsSync` +function exists(file) { + try { + if (fs.statSync(file).isFile()) { + return true; + } + } catch (e) { + return false; + } +} diff --git a/octorun/node_modules/commander/package.json b/octorun/node_modules/commander/package.json new file mode 100644 index 000000000..b33979d03 --- /dev/null +++ b/octorun/node_modules/commander/package.json @@ -0,0 +1,114 @@ +{ + "_args": [ + [ + "commander@^2.14.1", + "C:\\Users\\Spade\\Projects\\GitHub\\Unity\\octorun" + ] + ], + "_from": "commander@>=2.14.1 <3.0.0", + "_id": "commander@2.14.1", + "_inCache": true, + "_location": "/commander", + "_nodeVersion": "9.4.0", + "_npmOperationalInternal": { + "host": "s3://npm-registry-packages", + "tmp": "tmp/commander_2.14.1_1517989378540_0.7122613806538618" + }, + "_npmUser": { + "email": "abe@enzou.tokyo", + "name": "abetomo" + }, + "_npmVersion": "5.6.0", + "_phantomChildren": {}, + "_requested": { + "name": "commander", + "raw": "commander@^2.14.1", + "rawSpec": "^2.14.1", + "scope": null, + "spec": ">=2.14.1 <3.0.0", + "type": "range" + }, + "_requiredBy": [ + "/" + ], + "_resolved": "https://registry.npmjs.org/commander/-/commander-2.14.1.tgz", + "_shasum": "2235123e37af8ca3c65df45b026dbd357b01b9aa", + "_shrinkwrap": null, + "_spec": "commander@^2.14.1", + "_where": "C:\\Users\\Spade\\Projects\\GitHub\\Unity\\octorun", + "author": { + "email": "tj@vision-media.ca", + "name": "TJ Holowaychuk" + }, + "bugs": { + "url": "https://github.com/tj/commander.js/issues" + }, + "dependencies": {}, + "description": "the complete solution for node.js command-line programs", + "devDependencies": { + "@types/node": "^7.0.52", + "eslint": "^3.19.0", + "should": "^11.2.1", + "sinon": "^2.4.1", + "standard": "^10.0.3", + "typescript": "^2.7.1" + }, + "directories": {}, + "dist": { + "fileCount": 6, + "integrity": "sha512-+YR16o3rK53SmWHU3rEM3tPAh2rwb1yPcQX5irVn7mb0gXbwuCCrnkbV5+PBfETdfg1vui07nM6PCG1zndcjQw==", + "shasum": "2235123e37af8ca3c65df45b026dbd357b01b9aa", + "tarball": "https://registry.npmjs.org/commander/-/commander-2.14.1.tgz", + "unpackedSize": 58015 + }, + "files": [ + "index.js", + "typings/index.d.ts" + ], + "gitHead": "6b026a5c88a2c7f67db70831c015e9d11c7babca", + "homepage": "https://github.com/tj/commander.js#readme", + "installable": true, + "keywords": [ + "command", + "commander", + "option", + "parser" + ], + "license": "MIT", + "main": "index", + "maintainers": [ + { + "email": "abe@enzou.tokyo", + "name": "abetomo" + }, + { + "email": "rkoutnik@gmail.com", + "name": "somekittens" + }, + { + "email": "tj@vision-media.ca", + "name": "tjholowaychuk" + }, + { + "email": "romain.vanesyan@gmail.com", + "name": "vanesyan" + }, + { + "email": "zhiyelee@gmail.com", + "name": "zhiyelee" + } + ], + "name": "commander", + "optionalDependencies": {}, + "repository": { + "type": "git", + "url": "git+https://github.com/tj/commander.js.git" + }, + "scripts": { + "lint": "eslint index.js", + "test": "make test && npm run test-typings", + "test-typings": "node_modules/typescript/bin/tsc -p tsconfig.json" + }, + "typings": "typings/index.d.ts", + "version": "2.14.1" +} diff --git a/octorun/node_modules/commander/typings/index.d.ts b/octorun/node_modules/commander/typings/index.d.ts new file mode 100644 index 000000000..483076741 --- /dev/null +++ b/octorun/node_modules/commander/typings/index.d.ts @@ -0,0 +1,309 @@ +// Type definitions for commander 2.11 +// Project: https://github.com/visionmedia/commander.js +// Definitions by: Alan Agius , Marcelo Dezem , vvakame , Jules Randolph +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace local { + + class Option { + flags: string; + required: boolean; + optional: boolean; + bool: boolean; + short?: string; + long: string; + description: string; + + /** + * Initialize a new `Option` with the given `flags` and `description`. + * + * @param {string} flags + * @param {string} [description] + */ + constructor(flags: string, description?: string); + } + + class Command extends NodeJS.EventEmitter { + [key: string]: any; + + args: string[]; + + /** + * Initialize a new `Command`. + * + * @param {string} [name] + */ + constructor(name?: string); + + /** + * Set the program version to `str`. + * + * This method auto-registers the "-V, --version" flag + * which will print the version number when passed. + * + * @param {string} str + * @param {string} [flags] + * @returns {Command} for chaining + */ + version(str: string, flags?: string): Command; + + /** + * Add command `name`. + * + * The `.action()` callback is invoked when the + * command `name` is specified via __ARGV__, + * and the remaining arguments are applied to the + * function for access. + * + * When the `name` is "*" an un-matched command + * will be passed as the first arg, followed by + * the rest of __ARGV__ remaining. + * + * @example + * program + * .version('0.0.1') + * .option('-C, --chdir ', 'change the working directory') + * .option('-c, --config ', 'set config path. defaults to ./deploy.conf') + * .option('-T, --no-tests', 'ignore test hook') + * + * program + * .command('setup') + * .description('run remote setup commands') + * .action(function() { + * console.log('setup'); + * }); + * + * program + * .command('exec ') + * .description('run the given remote command') + * .action(function(cmd) { + * console.log('exec "%s"', cmd); + * }); + * + * program + * .command('teardown [otherDirs...]') + * .description('run teardown commands') + * .action(function(dir, otherDirs) { + * console.log('dir "%s"', dir); + * if (otherDirs) { + * otherDirs.forEach(function (oDir) { + * console.log('dir "%s"', oDir); + * }); + * } + * }); + * + * program + * .command('*') + * .description('deploy the given env') + * .action(function(env) { + * console.log('deploying "%s"', env); + * }); + * + * program.parse(process.argv); + * + * @param {string} name + * @param {string} [desc] for git-style sub-commands + * @param {CommandOptions} [opts] command options + * @returns {Command} the new command + */ + command(name: string, desc?: string, opts?: commander.CommandOptions): Command; + + /** + * Define argument syntax for the top-level command. + * + * @param {string} desc + * @returns {Command} for chaining + */ + arguments(desc: string): Command; + + /** + * Parse expected `args`. + * + * For example `["[type]"]` becomes `[{ required: false, name: 'type' }]`. + * + * @param {string[]} args + * @returns {Command} for chaining + */ + parseExpectedArgs(args: string[]): Command; + + /** + * Register callback `fn` for the command. + * + * @example + * program + * .command('help') + * .description('display verbose help') + * .action(function() { + * // output help here + * }); + * + * @param {(...args: any[]) => void} fn + * @returns {Command} for chaining + */ + action(fn: (...args: any[]) => void): Command; + + /** + * Define option with `flags`, `description` and optional + * coercion `fn`. + * + * The `flags` string should contain both the short and long flags, + * separated by comma, a pipe or space. The following are all valid + * all will output this way when `--help` is used. + * + * "-p, --pepper" + * "-p|--pepper" + * "-p --pepper" + * + * @example + * // simple boolean defaulting to false + * program.option('-p, --pepper', 'add pepper'); + * + * --pepper + * program.pepper + * // => Boolean + * + * // simple boolean defaulting to true + * program.option('-C, --no-cheese', 'remove cheese'); + * + * program.cheese + * // => true + * + * --no-cheese + * program.cheese + * // => false + * + * // required argument + * program.option('-C, --chdir ', 'change the working directory'); + * + * --chdir /tmp + * program.chdir + * // => "/tmp" + * + * // optional argument + * program.option('-c, --cheese [type]', 'add cheese [marble]'); + * + * @param {string} flags + * @param {string} [description] + * @param {((arg1: any, arg2: any) => void) | RegExp} [fn] function or default + * @param {*} [defaultValue] + * @returns {Command} for chaining + */ + option(flags: string, description?: string, fn?: ((arg1: any, arg2: any) => void) | RegExp, defaultValue?: any): Command; + option(flags: string, description?: string, defaultValue?: any): Command; + + /** + * Allow unknown options on the command line. + * + * @param {boolean} [arg] if `true` or omitted, no error will be thrown for unknown options. + * @returns {Command} for chaining + */ + allowUnknownOption(arg?: boolean): Command; + + /** + * Parse `argv`, settings options and invoking commands when defined. + * + * @param {string[]} argv + * @returns {Command} for chaining + */ + parse(argv: string[]): Command; + + /** + * Parse options from `argv` returning `argv` void of these options. + * + * @param {string[]} argv + * @returns {ParseOptionsResult} + */ + parseOptions(argv: string[]): commander.ParseOptionsResult; + + /** + * Return an object containing options as key-value pairs + * + * @returns {{[key: string]: string}} + */ + opts(): { [key: string]: string }; + + /** + * Set the description to `str`. + * + * @param {string} str + * @return {(Command | string)} + */ + description(str: string): Command; + description(): string; + + /** + * Set an alias for the command. + * + * @param {string} alias + * @return {(Command | string)} + */ + alias(alias: string): Command; + alias(): string; + + /** + * Set or get the command usage. + * + * @param {string} str + * @return {(Command | string)} + */ + usage(str: string): Command; + usage(): string; + + /** + * Set the name of the command. + * + * @param {string} str + * @return {Command} + */ + name(str: string): Command; + + /** + * Get the name of the command. + * + * @return {string} + */ + name(): string; + + /** + * Output help information for this command. + * + * @param {(str: string) => string} [cb] + */ + outputHelp(cb?: (str: string) => string): void; + + /** Output help information and exit. + * + * @param {(str: string) => string} [cb] + */ + help(cb?: (str: string) => string): void; + } + +} + +declare namespace commander { + + type Command = local.Command + + type Option = local.Option + + interface CommandOptions { + noHelp?: boolean; + isDefault?: boolean; + } + + interface ParseOptionsResult { + args: string[]; + unknown: string[]; + } + + interface CommanderStatic extends Command { + Command: typeof local.Command; + Option: typeof local.Option; + CommandOptions: CommandOptions; + ParseOptionsResult: ParseOptionsResult; + } + +} + +declare const commander: commander.CommanderStatic; +export = commander; diff --git a/octorun/node_modules/dotenv/.editorconfig b/octorun/node_modules/dotenv/.editorconfig new file mode 100644 index 000000000..5d1263484 --- /dev/null +++ b/octorun/node_modules/dotenv/.editorconfig @@ -0,0 +1,13 @@ +# editorconfig.org +root = true + +[*] +indent_style = space +indent_size = 2 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +[*.md] +trim_trailing_whitespace = false diff --git a/octorun/node_modules/dotenv/.npmignore b/octorun/node_modules/dotenv/.npmignore new file mode 100644 index 000000000..519e4f277 --- /dev/null +++ b/octorun/node_modules/dotenv/.npmignore @@ -0,0 +1,12 @@ +# Coverage directory used by tools like istanbul +coverage + +# Dependency directory +# Commenting this out is preferred by some people, see +# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git- +node_modules + +# Users Environment Variables +.lock-wscript + +.DS_Store diff --git a/octorun/node_modules/dotenv/.travis.yml b/octorun/node_modules/dotenv/.travis.yml new file mode 100644 index 000000000..ba0b1445c --- /dev/null +++ b/octorun/node_modules/dotenv/.travis.yml @@ -0,0 +1,6 @@ +language: node_js + +node_js: + - iojs + - 0.12 + - 0.10 diff --git a/octorun/node_modules/dotenv/Contributing.md b/octorun/node_modules/dotenv/Contributing.md new file mode 100644 index 000000000..04552a9e0 --- /dev/null +++ b/octorun/node_modules/dotenv/Contributing.md @@ -0,0 +1,25 @@ +# Contributing + +1. Fork it +2. `npm install` +3. Create your feature branch (`git checkout -b my-new-feature`) +4. Commit your changes (`git commit -am 'Added some feature'`) +5. `npm test` +6. Push to the branch (`git push origin my-new-feature`) +7. Create new Pull Request + +## Testing + +We use [lab](https://github.com/hapijs/lab) and [should](https://github.com/shouldjs/should.js) to write BDD test. Run our test suite with this command: + +``` +npm test +``` + +## Code Style + +We use [standard](https://www.npmjs.com/package/standard) and [editorconfig](http://editorconfig.org) to maintain code style and best practices. Please make sure your PR adheres to the guides by running: + +``` +npm run lint +``` diff --git a/octorun/node_modules/dotenv/README.md b/octorun/node_modules/dotenv/README.md new file mode 100644 index 000000000..de324261a --- /dev/null +++ b/octorun/node_modules/dotenv/README.md @@ -0,0 +1,198 @@ +# dotenv + +dotenv + +Dotenv loads environment variables from `.env` into `ENV` (process.env). + +[![BuildStatus](https://img.shields.io/travis/motdotla/dotenv/master.svg?style=flat-square)](https://travis-ci.org/motdotla/dotenv) +[![NPM version](https://img.shields.io/npm/v/dotenv.svg?style=flat-square)](https://www.npmjs.com/package/dotenv) +[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard) + +> "Storing [configuration in the environment](http://www.12factor.net/config) +> is one of the tenets of a [twelve-factor app](http://www.12factor.net/). +> Anything that is likely to change between deployment environments–such as +> resource handles for databases or credentials for external services–should be +> extracted from the code into environment variables. +> +> But it is not always practical to set environment variables on development +> machines or continuous integration servers where multiple projects are run. +> Dotenv loads variables from a `.env` file into ENV when the environment is +> bootstrapped." +> +> [Brandon Keepers' Dotenv in Ruby](https://github.com/bkeepers/dotenv) + +## Install + +```bash +npm install dotenv --save +``` + +## Usage + +As early as possible in your application, require and load dotenv. + +```javascript +require('dotenv').load(); +``` + +Create a `.env` file in the root directory of your project. Add +environment-specific variables on new lines in the form of `NAME=VALUE`. +For example: + +``` +DB_HOST=localhost +DB_USER=root +DB_PASS=s1mpl3 +``` + +That's it. + +`process.env` now has the keys and values you defined in your `.env` file. + +```javascript +db.connect({ + host: process.env.DB_HOST, + username: process.env.DB_USER, + password: process.env.DB_PASS +}); +``` + +### Preload + +If you are using iojs-v1.6.0 or later, you can use the `--require` (`-r`) command line option to preload dotenv. By doing this, you do not need to require and load dotenv in your application code. + + +```bash +$ node -r dotenv/config your_script.js +``` + +The configuration options below are supported as command line arguments in the format `dotenv_config_