Skip to content
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

Add and release OpenUPM support. #663

Merged
merged 6 commits into from
Dec 21, 2023
Merged

Conversation

f1yingbanana
Copy link
Contributor

This PR:

  • adds OpenUPM support by copying the content of the UPM package in the release process back to the repo,
  • updates the README to reflect latest steps in using EDM4U, and
  • generates artifacts for a new release containing these changes

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.
build.gradle Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
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.

@a-maurice a-maurice merged commit ecae23d into googlesamples:master Dec 21, 2023
1 check passed
@googlesamples googlesamples locked and limited conversation to collaborators Jan 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants