generated from YunoHost/example_ynh
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #17 from ewilly/master
Rewrite from scratch including v2
- Loading branch information
Showing
37 changed files
with
855 additions
and
2,142 deletions.
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| name: YunoHost apps package linter | ||
|
|
||
| on: | ||
| # Allow to manually trigger the workflow | ||
| workflow_dispatch: | ||
| push: | ||
| pull_request: | ||
|
|
||
| jobs: | ||
| test: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - name: Set up Python | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: '3.9' | ||
|
|
||
| - name: Install dependencies | ||
| run: | | ||
| python -m pip install --upgrade pip | ||
| pip install toml pyparsing six | ||
| - name: 'Clone YunoHost apps package linter' | ||
| run: | | ||
| git clone --depth=1 https://github.com/YunoHost/package_linter ~/package_linter | ||
| - name: 'Run linter' | ||
| run: | | ||
| ~/package_linter/package_linter.py . |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| name: Create master promotion pull request | ||
| on: | ||
| # Allow to manually trigger the workflow | ||
| workflow_dispatch: | ||
| # Run it when when someone pushes to testing | ||
| push: | ||
| branches: | ||
| - testing | ||
| jobs: | ||
| masterPromotion: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| ref: master | ||
| - name: Reset promotion branch | ||
| run: | | ||
| git fetch origin testing:testing | ||
| git reset --hard testing | ||
| - name: Create Pull Request | ||
| uses: peter-evans/create-pull-request@v6 | ||
| with: | ||
| branch: master-promotion | ||
| title: 'Upgrade master from testing' | ||
| body: | | ||
| Upgrade master from testing |
This file was deleted.
Oops, something went wrong.
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,21 @@ | ||
| File containing the license of your package. | ||
| MIT License | ||
|
|
||
| More information here: | ||
| https://yunohost.org/packaging_apps_guidelines#yep-1-3 | ||
| Copyright (c) 2022 Hau Tran | ||
|
|
||
| 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. |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,85 +1,48 @@ | ||
| # Packaging an app, starting from this example | ||
|
|
||
| * Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo. | ||
| * Edit the `manifest.json` with app specific info. | ||
| * Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`. | ||
| * Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers) | ||
| * Add a `LICENSE` file for the package. | ||
| * Edit `doc/DISCLAIMER*.md` | ||
| * The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator | ||
|
|
||
| --- | ||
| <!-- | ||
| N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator | ||
| It shall NOT be edited by hand. | ||
| --> | ||
|
|
||
| # Example app for YunoHost | ||
| # Immich for YunoHost | ||
|
|
||
| [](https://dash.yunohost.org/appci/app/immich)   | ||
|
|
||
| [](https://dash.yunohost.org/appci/app/example)   | ||
| [](https://install-app.yunohost.org/?app=example) | ||
| [](https://install-app.yunohost.org/?app=immich) | ||
|
|
||
| *[Lire ce readme en français.](./README_fr.md)* | ||
|
|
||
| > *This package allows you to install Example app quickly and simply on a YunoHost server. | ||
| > *This package allows you to install Immich quickly and simply on a YunoHost server. | ||
| If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* | ||
|
|
||
| ## Overview | ||
|
|
||
| Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. | ||
|
|
||
| ### Features | ||
|
|
||
| - Ut enim ad minim veniam, quis nostrud exercitation ullamco ; | ||
| - Laboris nisi ut aliquip ex ea commodo consequat ; | ||
| - Duis aute irure dolor in reprehenderit in voluptate ; | ||
| - Velit esse cillum dolore eu fugiat nulla pariatur ; | ||
| - Excepteur sint occaecat cupidatat non proident, sunt in culpa." | ||
|
|
||
| Photo and video backup solution directly from your mobile phone | ||
|
|
||
| **Shipped version:** 1.0~ynh1 | ||
|
|
||
|
|
||
| **Demo:** https://demo.example.com | ||
| **Shipped version:** 1.90.2~ynh1 | ||
|
|
||
| ## Screenshots | ||
|
|
||
|  | ||
|
|
||
| ## Disclaimers / important information | ||
|
|
||
| * Any known limitations, constrains or stuff not working, such as (but not limited to): | ||
| * requiring a full dedicated domain ? | ||
| * architectures not supported ? | ||
| * not-working single-sign on or LDAP integration ? | ||
| * the app requires an important amount of RAM / disk / .. to install or to work properly | ||
| * etc... | ||
|
|
||
| * Other infos that people should be aware of, such as: | ||
| * any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...) | ||
| * how to configure / administrate the application if it ain't obvious | ||
| * upgrade process / specificities / things to be aware of ? | ||
| * security considerations ? | ||
|  | ||
|
|
||
| ## Documentation and resources | ||
|
|
||
| * Official app website: <https://example.com> | ||
| * Official user documentation: <https://yunohost.org/apps> | ||
| * Official admin documentation: <https://yunohost.org/packaging_apps> | ||
| * Upstream app code repository: <https://some.forge.com/example/example> | ||
| * YunoHost documentation for this app: <https://yunohost.org/app_example> | ||
| * Report a bug: <https://github.com/YunoHost-Apps/example_ynh/issues> | ||
| * Official app website: <https://www.immich.app> | ||
| * Official user documentation: <https://github.com/immich-app/immich#getting-started> | ||
| * Official admin documentation: <https://github.com/immich-app/immich#getting-started> | ||
| * Upstream app code repository: <https://github.com/immich-app/immich> | ||
| * YunoHost Store: <https://apps.yunohost.org/app/immich> | ||
| * Report a bug: <https://github.com/YunoHost-Apps/immich_ynh/issues> | ||
|
|
||
| ## Developer info | ||
|
|
||
| Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing). | ||
| Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/immich_ynh/tree/testing). | ||
|
|
||
| To try the testing branch, please proceed like that. | ||
|
|
||
| ``` bash | ||
| sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug | ||
| sudo yunohost app install https://github.com/YunoHost-Apps/immich_ynh/tree/testing --debug | ||
| or | ||
| sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug | ||
| sudo yunohost app upgrade immich -u https://github.com/YunoHost-Apps/immich_ynh/tree/testing --debug | ||
| ``` | ||
|
|
||
| **More info regarding app packaging:** <https://yunohost.org/packaging_apps> |
Oops, something went wrong.