https://github.com/colcon/colcon-metadata-repository
https://github.com/colcon/colcon-metadata-repository
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/colcon/colcon-metadata-repository
- Owner: colcon
- License: cc0-1.0
- Created: 2018-01-06T03:09:07.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-05-16T13:40:01.000Z (about 1 year ago)
- Last Synced: 2025-06-11T21:41:31.980Z (about 1 year ago)
- Language: Python
- Homepage: http://colcon.readthedocs.io
- Size: 9.77 KB
- Stars: 5
- Watchers: 5
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Repository of package metadata
==============================
Some software packages don't provide their metadata in a machine readable
format.
To allow processing them in an automated fashion this repository makes these
information available, e.g. for the command line tool `colcon`.
How to use the Information
--------------------------
To register this repository with `colcon` (using the identifier "default")
invoke the following command:
```
colcon metadata add default https://raw.githubusercontent.com/colcon/colcon-metadata-repository/master/index.yaml
```
Afterwards as well as on a regular base fetch the latest content from the
repository:
```
colcon metadata update default
```
How to contribute additional information
----------------------------------------
Initially fork this repository.
For each contribution perform the following steps:
* Create or modify one or multiple files ending with `.meta`.
* Add any new files in alphabetical order to the `index.yaml` file.
* Run the `lint.py` script to ensure that the changes follow the recommended
yaml style.
* The script requires [yamllint](https://yamllint.readthedocs.io/en/stable/index.html) to be installed.
* Create a pull request with the changes.