Add and release OpenUPM support.#663
Merged
a-maurice merged 6 commits intogooglesamples:masterfrom Dec 21, 2023
Merged
Conversation
This commit modifies the build.gradle file so that it explodes the generated UPM package into the repo as part of the release process.
This commit also runs the MD linter on the file.
a-maurice
reviewed
Dec 21, 2023
Collaborator
There was a problem hiding this comment.
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?
Contributor
Author
There was a problem hiding this comment.
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:
- Adding OpenUPM badges to the top of the page.
- Formatting headings, so there is only one h1 (title). Essentially this moves all headings down one level.
- Adding a section on who should do what with EDM4U (target audience) to Overview.
- Rewriting Getting Started section to include exactly how to download and install EDM4U, with a section on conflict resolution.
- 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.
- Unifying all component usages under a Usages section.
- Refactoring the repetitive download sample config file bullet list in each of the component usage sections into Getting Started section.
- 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.
- Clarifying build requirement (Unity 2021 or lower, must build with Java 11).
- Running
hg fixon the markdown file.
Taken from [pull/561](googlesamples#561) on main repo.
a-maurice
approved these changes
Dec 21, 2023
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR: