-
-
Notifications
You must be signed in to change notification settings - Fork 17
feat: New macros, cleanup and clarification on flag arguments #271
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
base: main
Are you sure you want to change the base?
Conversation
Deploying devdocs with
|
| Latest commit: |
ec27091
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://b0b2b183.devdocs-next.pages.dev |
| Branch Preview URL: | https://gil-chore-more-macros.devdocs-next.pages.dev |
| - Defer to what the desktop file originally contained if you are unsure which to use. | ||
|
|
||
| ### %desktop_file_install | ||
| SHOULD be used to install a .desktop file. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Update the policy/guidelines/wherever the .desktop stuff is to do this/link to this
| #### %npm_build | ||
| SHOULD be used for building Electron or Tauri apps with NPM. Has a great deal of flags to work around NPM specific limitations. | ||
|
|
||
| Available flags: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Examples for these would be nice too
Co-authored-by: Owen Zimmerman <123591347+Owen-sz@users.noreply.github.com>
| See [Development and Shared Libraries](/terra/guidelines#development-and-shared-libraries) section. | ||
|
|
||
| Install `.desktop` file to `%_appsdir` for graphical apps. [Guide here](/terra/guidelines#providing-your-own-desktop-file). Prefer upstream provided ones over manually generating one. | ||
| Install `.desktop` file to `%_appsdir` for graphical apps. [Guide here](/terra/guidelines#providing-your-own-desktop-file). Prefer upstream provided ones over manually generating one. It is RECOMMENDED to use our [.desktop file macros](/terra/srpm#desktop-file-macros) for installing and editing .desktop files. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't this be MUST or SHOULD?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I based it off how other parts like this were worded TBH.
pages/terra/guidelines.mdx
Outdated
| # and other development files (.vapi, .typelib, .gir, etc.). | ||
| ``` | ||
| ### JavaScript | ||
| These are guidelines for packaging projects written in oe which utilize [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Written in oe?
pages/terra/guidelines.mdx
Outdated
|
|
||
| <Callout type="info"> | ||
| "Node modules" in this document refers to JavaScript packages run using a JavaScript runtime (usually Node.js), which are hosted on the [NPM Registry](https://www.npmjs.com).<br /> | ||
| "JavaScript modules," however, refers to to JavaScript packages run using a JavaScript runtime which are hosted on *either* the NPM Registry or the [JavaScript Registry](https://jsr.io), the latter of which are also called "modern JavaScript packages." This means Node modules are JavaScript modules, but not the other way around.<br /> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Refers to to
| SHOULD be used in place of manually creating `-static` subpackages. | ||
| **NOTE:** You still need to define a `%package static{:rpmspec}`, and then use this macro below this. | ||
| <Callout type="warning"> | ||
| You still need to define a `%package static`, and then use this macro below this. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| You still need to define a `%package static`, and then use this macro below this. | |
| You still need to define a `%package static`, and then use this macro below that. |
| SHOULD be used in place of manually creating `-libs` subpackages. | ||
| **NOTE:** You still need to define a `%package libs{:rpmspec}`, and then use this macro below this. | ||
| <Callout type="warning"> | ||
| You still need to define a `%package libs`, and then use this macro below this. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| You still need to define a `%package libs`, and then use this macro below this. | |
| You still need to define a `%package libs`, and then use this macro below that. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is referring to the macro displayed directly above it so wouldn't "this" be more correct? (Plus all I did was move the existing text into a callout for formatting reasons.)
No description provided.