<commit_before># Packaging Rake Tasks

This is 'packaging\_rake\_tasks' Ruby gem package.

This gem contains useful tasks for packaging, checking and building with
[Open Build Service](http://openbuildservice.org/).


# Quick Start

For a quick start just add to your Rakefile:

    require "packaging"

    Packaging::Configuration.run do |conf|
      conf.obs_project = "<obs_devel_project>"
      conf.package_name = "<package_name>"
    end

All shared tasks will be found and loaded automatically,
you can verify it with `rake -T` command.

It is recommended to check whether the defaults fit your needs
and change the configuration if needed.

# Documentation
## Online Fresh Generated
Is available at
[rubydoc.info](http://rubydoc.info/github/openSUSE/packaging_tasks/master/frames)

## Explanation of Provided Tasks

### check:commited
Checks if all changes to the local git repository are commited.
It doesn't check if changes
are sent to a remote git repository. Its main intention is to ensure that all
changes are tracked before making a package.

### check:license
Checks if all non-trivial files have a license header.
It is needed because there are
countries where implicitely everything is private unless stated otherwise
and also to help License Digger check licenses.
The check looks for a "copyright" notice or a prefix `Source:`
if the file is copied from a different source.
To skip some files use `skip_license_check` configuration option.

### check:osc
Checks if [`osc`](http://en.opensuse.org/openSUSE:OSC) is installed
and configured to allow sending to an OBS project. Its
goal is to make start of developing easier with helpful error messages.

### check:syntax
Checks syntax of all ruby files that can be found.

### osc:build
Runs local build using `osc` command. It uses separate build roots for each
basesystem for more efficient caching.

### osc:commit
Commit recent version to OBS devel project. It runs all checks and create recent
package.

### osc:sr
Creates a submit request to the target OBS project
(specified with `obs_sr_project` configuration option).
That includes running `osc:commit`.<commit_msg>make description of osc:commit more clear<commit_after># Packaging Rake Tasks

This is 'packaging\_rake\_tasks' Ruby gem package.

This gem contains useful tasks for packaging, checking and building with
[Open Build Service](http://openbuildservice.org/).


# Quick Start

For a quick start just add to your Rakefile:

    require "packaging"

    Packaging::Configuration.run do |conf|
      conf.obs_project = "<obs_devel_project>"
      conf.package_name = "<package_name>"
    end

All shared tasks will be found and loaded automatically,
you can verify it with `rake -T` command.

It is recommended to check whether the defaults fit your needs
and change the configuration if needed.

# Documentation
## Online Fresh Generated
Is available at
[rubydoc.info](http://rubydoc.info/github/openSUSE/packaging_tasks/master/frames)

## Explanation of Provided Tasks

### check:commited
Checks if all changes to the local git repository are commited.
It doesn't check if changes
are sent to a remote git repository. Its main intention is to ensure that all
changes are tracked before making a package.

### check:license
Checks if all non-trivial files have a license header.
It is needed because there are
countries where implicitely everything is private unless stated otherwise
and also to help License Digger check licenses.
The check looks for a "copyright" notice or a prefix `Source:`
if the file is copied from a different source.
To skip some files use `skip_license_check` configuration option.

### check:osc
Checks if [`osc`](http://en.opensuse.org/openSUSE:OSC) is installed
and configured to allow sending to an OBS project. Its
goal is to make start of developing easier with helpful error messages.

### check:syntax
Checks syntax of all ruby files that can be found.

### osc:build
Runs local build using `osc` command. It uses separate build roots for each
basesystem for more efficient caching.

### osc:commit
Commit current state of git tree to OBS devel project. It runs all checks and create package.

### osc:sr
Creates a submit request to the target OBS project
(specified with `obs_sr_project` configuration option).
That includes running `osc:commit`.
{'fraction_non_alphanumeric': 0.06553960166743864, 'fraction_numerical': 0.0, 'mean_word_length': 4.580103359173127, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1607942', 'n_tokens_mistral': 1151, 'n_tokens_neox': 1127, 'n_words': 574}