https://github.com/flathub/shared-modules

Common Flatpak modules that can be used as a git submodule
https://github.com/flathub/shared-modules

Last synced: about 2 months ago
JSON representation

Common Flatpak modules that can be used as a git submodule

• Host: GitHub
• URL: https://github.com/flathub/shared-modules
• Owner: flathub
• Created: 2017-04-18T08:58:32.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-10-27T13:47:48.000Z (2 months ago)
• Last Synced: 2024-10-27T15:22:56.356Z (2 months ago)
• Language: CMake
• Homepage:
• Size: 299 KB
• Stars: 109
• Watchers: 23
• Forks: 88
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
This repository contains commonly shared modules and is intended to be used as a git submodule.

Each submodule may include additional instructions to be used properly. Please check the folder containing that module to see if anything extra needs to be done.

## Adding

To use shared modules for packaging an application, add the submodule:

```

git submodule add https://github.com/flathub/shared-modules.git

```

## Usage

Then modules from this repository can be specified in an application

manifest.

```json

"modules": [

  "shared-modules/SDL/SDL-1.2.15.json",

  {

    "name": "foo"

  }

]

```

And for a YAML manifest:

```YAML

modules:

  - shared-modules/SDL/SDL-1.2.15.json

  - name: foo

```

## Updating

To update the submodule:

```

git submodule update --remote --merge

```

## Removing

To remove the submodule:

```

git submodule deinit -f -- shared-modules

rm -rf .git/modules/shared-modules

git rm -f shared-modules

rm .gitmodules

```

We provide an automatic updating mechanism for submodules located here. In order to utilize it:

- Set up x-checker-data for your sources: https://github.com/flathub/flatpak-external-data-checker#url-checker

And it will check for updates in a weekly basis.

Please do not request adding modules unless they are widely used in

the Flathub repository.

All shared modules manifests in this repository are, and need to be, in the JSON format,

which is supported by both Flatpak manifest formats, JSON and YAML.