Skip to content

Add and release OpenUPM support. #663

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Dec 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Version 1.2.178 - Dec 20, 2023
* Added [OpenUPM support](https://openupm.com/packages/com.google.external-dependency-manager/).

# Version 1.2.177 - Aug 14, 2023
* iOS Resolver - Added `/opt/homebrew/bin` to Cocoapod executable search path.
Fixes #627
Expand Down
1,296 changes: 677 additions & 619 deletions README.md
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general, I'm guessing you used a markdown editor that autoformatted this file a bunch. The problem is the formatting doesn't seem to match what GitHub expects, so it breaks things like the bullet points, and it also makes it hard to tell what was actually changed. Any chance you can limit this just to the significant changes?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I ran this with hg fix, but I believe the formatting results are displayed correctly. Please take a look at the preview on my fork.

I agree that I might have made more changes than I originally intended when I went through the entire README file. Here are the list of changes I've made, let me know which ones you want me to revert:

  1. Adding OpenUPM badges to the top of the page.
  2. Formatting headings, so there is only one h1 (title). Essentially this moves all headings down one level.
  3. Adding a section on who should do what with EDM4U (target audience) to Overview.
  4. Rewriting Getting Started section to include exactly how to download and install EDM4U, with a section on conflict resolution.
  5. Moving the section on embedding EDM4U in other packages (originally in Getting Started) into its own section below, since it is no longer necessary nor endorsed.
  6. Unifying all component usages under a Usages section.
  7. Refactoring the repetitive download sample config file bullet list in each of the component usage sections into Getting Started section.
  8. Moving Requirements, Getting Started, and Usages above Background, in line with general README guides (see Guide to writing on Readme.md (.markdown)file for GitHub project, How to Write a Good README File for Your GitHub Project. The motivation is that Background is good information, but is less important than how to install and use EDM4U.
  9. Clarifying build requirement (Unity 2021 or lower, must build with Java 11).
  10. Running hg fix on the markdown file.

Large diffs are not rendered by default.

23 changes: 19 additions & 4 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ project.ext {
// Directory for testing.
testDir = new File(scriptDirectory, "test_output")
// Version of the plugin (update this with CHANGELOG.md on each release).
pluginVersion = "1.2.177"
pluginVersion = "1.2.178"
// Directory that contains the template plugin.
// Files under this directory are copied into the staging area for the
// plugin.
Expand All @@ -264,14 +264,18 @@ project.ext {
pluginStagingAreaDir = new File(buildDir, "staging")
// Directory where the build plugin is unpacked to.
pluginExplodedDir = new File(scriptDirectory, "exploded")
// Directory where the UPM package is unpacked to.
pluginUpmDir = new File(scriptDirectory, "upm")
// Base filename of the released plugin.
currentPluginBasename = "external-dependency-manager"
// Base UPM package name of the released plugin.
currentPluginUpmPackageName = "com.google.external-dependency-manager"
// Where the exported plugin file is built before it's copied to the release
// location.
pluginExportFile = new File(buildDir, currentPluginBasename + ".unitypackage")
// Where the exported UPM plugin file is built.
pluginUpmExportFile = new File(buildDir,
currentPluginBasename + pluginVersion + ".tgz")
currentPluginUpmPackageName + "-" + pluginVersion + ".tgz")
// Directory within the plugin staging area that just contains the plugin.
pluginAssetsDir = new File("Assets", "ExternalDependencyManager")
// Directories within the staging area to export.
Expand Down Expand Up @@ -2069,8 +2073,7 @@ buildPlugin.with {
}

// Guid paths for UPM package.
File upmPluginPackageDir = new File("com.google.external-dependency-manager",
"ExternalDependencyManager")
File upmPluginPackageDir = new File(currentPluginUpmPackageName, "ExternalDependencyManager")
File upmPluginEditorDir = new File(upmPluginPackageDir, "Editor")
File upmPluginDllDir = new File(upmPluginEditorDir, project.ext.pluginVersion)

Expand Down Expand Up @@ -2121,6 +2124,7 @@ task releasePlugin(dependsOn: [buildPlugin, buildUpmPlugin]) {
fileTree(dir: project.ext.pluginExplodedDir),
pluginTemplateFilesMap.values())
doLast {
// Delete and regenerate built .unitypackage in the repo.
delete fileTree(
dir: project.ext.pluginReleaseFile.parentFile,
includes: [project.ext.currentPluginBasename + "-*.unitypackage"])
Expand All @@ -2134,6 +2138,7 @@ task releasePlugin(dependsOn: [buildPlugin, buildUpmPlugin]) {
into project.ext.pluginReleaseFileUnversioned.parentFile
rename { src_filename -> project.ext.pluginReleaseFileUnversioned.name }
}
// Delete and regenerate the exploded plugin folder in the repo.
delete fileTree(dir: project.ext.pluginExplodedDir)
copy {
from project.ext.pluginStagingAreaDir
Expand All @@ -2142,6 +2147,16 @@ task releasePlugin(dependsOn: [buildPlugin, buildUpmPlugin]) {
it.path + "/**/*"
}
}
// Delete and regenerate the UPM package in the repo.
delete fileTree(dir: project.ext.pluginUpmDir)
copy {
// Rename the top-level package folder to upm.
eachFile {
path = path.replaceFirst(/^.+?\//, "upm/")
}
from tarTree(project.ext.pluginUpmExportFile)
into project.ext.scriptDirectory
}
pluginTemplateFilesMap.each {
sourceFile, targetFile -> copyFile(sourceFile, targetFile)
}
Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

This file was deleted.

Binary file not shown.
Binary file not shown.

This file was deleted.

Binary file not shown.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file not shown.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file not shown.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file not shown.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file not shown.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file not shown.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file not shown.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file not shown.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions exploded/Assets/ExternalDependencyManager/Editor/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Version 1.2.178 - Dec 20, 2023
* Added [OpenUPM support](https://openupm.com/packages/com.google.external-dependency-manager/).

# Version 1.2.177 - Aug 14, 2023
* iOS Resolver - Added `/opt/homebrew/bin` to Cocoapod executable search path.
Fixes #627
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file not shown.
Binary file not shown.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file not shown.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions exploded/Assets/ExternalDependencyManager/Editor/LICENSE.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading