Improvements

[lslezak]

Here are some small improvements for the rake tasks:

Added osc:config task

The packaging configuration might be complex and it might be quite difficult to find where the package will be submitted with the osc:sr task. This task prints the summary of the packaging configuration:

# rake osc:config
Package directory: package
OBS instance:      https://api.opensuse.org/
OBS project:       devel:languages:ruby:extensions
OBS package name:  rubygem-packaging_rake_tasks
OBS build target:  openSUSE_Tumbleweed
OBS submit target: openSUSE:Factory

It also honors the YAST_SUBMIT variable in the YaST packages:

# YAST_SUBMIT=sle15sp1 rake osc:config
Package directory: package
OBS instance:      https://api.suse.de/
OBS project:       Devel:YaST:SLE-15-SP1
OBS package name:  yast2
OBS build target:  SUSE_SLE-15-SP1_Update
OBS submit target: SUSE:SLE-15-SP1:Update

Git Commit Check

The osc:build or osc:sr tasks check whether all changes have been committed to Git to avoid missing files and changes. That's good. But if you are testing a fix it is quite annoying that you have to commit every single change before running a testing build.

Also I'd like to use it in the rake task for running the GitHub Actions locally, forcing developers to commit every change before running the tests would be really annoying...

Usage:

rake osc:build CHECK_MODIFIED=0

Note: We need to keep the check for new files because rake package archives only the files known to Git, so the package build would miss them.

Other Changes

• Use syntax highlighting in the README.md file
• The rake install now uses sudo to make package building and installing easier
• Fixed several spelling issues

[jreidinger]

I am not sure how it will work with removed/added files.

[lslezak]

Good point... 😟

[jreidinger]

So please document it in README as caveeat as it can surprise users. Otherwise change looks good.

[lslezak]

Updated.

[jreidinger]

to be honest I do not like much this change as forces sudo usage and on some machines sudo is not even available. for make install you also need to use sudo make install

[lslezak]

There is a difference to make, first you call make then sudo make install so only the install part runs with the root permissions.

If you run sudo rake install here it will also create the *.gem file as root. That's bad, I'd like to run only the really necessary steps as root, if there is a bug in creating the gem file then you could break your system easily.

Moreover if you want to delete the gem you also need sudo:

# ls -l package/*.gem
-rw-r--r-- 1 root root 23552 Mar 24 17:52 package/packaging_rake_tasks-1.5.0.gem

I'dd add root and sudo detection....

[mvidner]

What about naming the option after the task, CHECK_COMMITTED ?

[lslezak]

It turned out that we need to keep the check for new files because rake package archives only the files known to Git, so the package build would miss them.

So we can only skip the check for modified files. But that would be still sufficient in many situations.

[lslezak]

Let's use CHECK_MODIFIED instead...

[jreidinger]

another option is to use su -c in case sudo is not available

[lslezak]

This rake install task is called only by developers when testing the gem locally, I'd keep it simple...

[mvidner]

Just one place in the docs has escaped the renaming, otherwise LGTM
Thanks!