Skip to content

Commit

Permalink
more documentation for README.md
Browse files Browse the repository at this point in the history
* short description for each service
* documenation about archive formats
  • Loading branch information
M0ses committed May 23, 2017
1 parent 747de50 commit f11cf98
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,36 @@ This is the git repository for [openSUSE:Tools/obs-service-tar_scm](https://buil

The service can be used in combination with other services like [download_files](https://github.com/openSUSE/obs-service-download_files), [extract_file](https://github.com/openSUSE/obs-service-extract_file), [recompress](https://github.com/openSUSE/obs-service-recompress) or [set_version](https://github.com/openSUSE/obs-service-set_version) e.g. within the [GIT integration](https://en.opensuse.org/openSUSE:Build_Service_Concept_SourceService#Example_2:_GIT_integration) workflow.

## Archive Formats

### obscpio
The obscpio archive format is the new OBS specific archive format which used and generated by the [OBS Delta Store](http://openbuildservice.org/help/manuals/obs-reference-guide/cha.obs.architecture.html#delta_store) to store SCM changes in an incremental way.
It is used by the obs_scm service. A file <package>.obsinfo including useful information from your SCM system is generated, so you can access this data at buildtime.

### tar
The tar archive format is used to create a tarball and it is used by the services "tar" and "tar_scm"

## Services

### tar_scm
tar_scm is the legacy service to create a source tarball from a source code managment tool.

### obs_scm
obs_scm uses the new obscpio archive format to store the sources
It is recommended to use obs_scm in favour to tar_scm as it helps to save a lot of disk space on the server side, especially when used in continuous integration (e.g. nightly builds etc.).
You can use the tar service and recompress service as a buildtime service to generate the usual source tarball while buildtime.

### tar
Create a tarball out of obscpio archives

### snapcraft
The snapcraft service can be used to fetch sources before building a [snappy app](https://www.ubuntu.com/desktop/snappy).
It parses a snapcraft.yml, for the SCM related parts and executes the corresponding services.

### appimage
The appimage service can be used to fetch sources before building a [appimage app](http://appimage.org/).
It parses a appimage.yml for the SCM related parts and executes the corresponding services.

## Installation
The files in this top-level directory need to be installed using the following:

Expand Down

0 comments on commit f11cf98

Please sign in to comment.