Make it easier to supply custom archive to `packit srpm`

[TomasTomecek]

I see. Makes sense. But it would be good to have a little bit more easier / straightforward way how to prepare the upstream archive. For fmf I had to add three Makefile targets plus this:

   current_version_command: ["make", "packit-version"]

   actions:
       create-archive:
       - make packit-tarball
       - make packit-path

I believe it should be much simpler/shorter/obvious.

Originally posted by @psss in packit/packit-service#103 (comment)

[jpopelka]

AI:
Write down documentation on how to do this the easiest way.
Deprecate dedicated config options for getting version and creating archive command for sake of actions.

[psss]

So there is already a better way, just not yet documented? Or the implementation is also in progress?

[lachmanfrantisek]

So there is already a better way, just not yet documented? Or the implementation is also in progress?

• We need to document the prefered way for the current state at first. (It's definitely not so clear now.)
• We support some values that were replaced by the actions (e.g. current_version_command).
  • We want to get rid of those.
• After that, we can simplify the config or support more workflows so less people needs to do it.
  • Do you have some better way, how it can be configured?

[psss]

I think the best way would be just a single command which would either:

• show the resulting archive file name in the output (e.g. last line)
• or store the archive to the location provided in an environment variable

It should not be necessary to configure the current_version_command.

[lachmanfrantisek]

• show the resulting archive file name in the output (e.g. last line)

• This should work in the current version:
  https://github.com/packit-service/packit/blob/master/packit/upstream.py#L376
  https://github.com/packit-service/packit/blob/b6d9bf76f021e9053e8c4f52b15408407fd6a923/packit/upstream.py#L377

[psss]

Nice, thanks. Trying on psss/edd#10

[psss]

Does not seem to be working:

The create-archive action did not output a path to the
generated archive. Please make sure that an absolute path to
the archive is printed.

Here's the output of the make packit-tarball command:

> make packit-tarball
mkdir -p /home/psss/git/edd/tmp/{SOURCES,edd-0.3}
cp -a LICENSE README.rst Makefile edd.spec edd docs /home/psss/git/edd/tmp/edd-0.3
cp docs/man.rst /home/psss/git/edd/tmp
tail -n+16 README.rst >> /home/psss/git/edd/tmp/man.rst
rst2man /home/psss/git/edd/tmp/man.rst | gzip > /home/psss/git/edd/tmp/edd-0.3/docs/edd.1.gz
rst2html README.rst --stylesheet=style.css --link-stylesheet > /home/psss/git/edd/tmp/edd-0.3/docs/index.html
cd /home/psss/git/edd/tmp && tar cfj SOURCES/edd-0.3.tar.bz2 edd-0.3
/home/psss/git/edd/tmp/SOURCES/edd-0.3.tar.bz2

Is there anything wrong with the file path format? Or anything else needs to be done?

[lachmanfrantisek]

Is there anything wrong with the file path format? Or anything else needs to be done?

I am just playing with that locally.

[lachmanfrantisek]

Using user-defined script for ActionName.create_archive: ['make', 'packit-tarball']
13:37:52.794 utils.py          DEBUG  cmd = 'make packit-tarball'
13:37:52.845 utils.py          DEBUG  b'mkdir -p /home/flachman/Projects/psss/edd/tmp/{SOURCES,edd-0.3}'
13:37:52.848 utils.py          DEBUG  b'cp -a LICENSE README.rst Makefile edd.spec edd docs /home/flachman/Projects/psss/edd/tmp/edd-0.3'
13:37:52.852 utils.py          DEBUG  b'cp docs/man.rst /home/flachman/Projects/psss/edd/tmp'
13:37:52.854 utils.py          DEBUG  b'tail -n+16 README.rst >> /home/flachman/Projects/psss/edd/tmp/man.rst'
13:37:52.858 utils.py          DEBUG  b'rst2man /home/flachman/Projects/psss/edd/tmp/man.rst | gzip > /home/flachman/Projects/psss/edd/tmp/edd-0.3/docs/edd.1.gz'
13:37:53.439 utils.py          DEBUG  b'rst2html README.rst --stylesheet=style.css --link-stylesheet > /home/flachman/Projects/psss/edd/tmp/edd-0.3/docs/index.html'
13:37:54.122 utils.py          DEBUG  b'cd /home/flachman/Projects/psss/edd/tmp && tar cfj SOURCES/edd-0.3.tar.bz2 edd-0.3'
13:37:54.141 utils.py          DEBUG  b'/home/flachman/Projects/psss/edd/tmp/SOURCES/edd-0.3.tar.bz2'
13:37:54.142 base_git.py       DEBUG  Action command output: ['mkdir -p /home/flachman/Projects/psss/edd/tmp/{SOURCES,edd-0.3}\ncp -a LICENSE README.rst Makefile edd.spec edd docs /home/flachman/Projects/psss/edd/tmp/edd-0.3\ncp docs/man.rst /home/flachman/Projects/psss/edd/tmp\ntail -n+16 README.rst >> /home/flachman/Projects/psss/edd/tmp/man.rst\nrst2man /home/flachman/Projects/psss/edd/tmp/man.rst | gzip > /home/flachman/Projects/psss/edd/tmp/edd-0.3/docs/edd.1.gz\nrst2html README.rst --stylesheet=style.css --link-stylesheet > /home/flachman/Projects/psss/edd/tmp/edd-0.3/docs/index.html\ncd /home/flachman/Projects/psss/edd/tmp && tar cfj SOURCES/edd-0.3.tar.bz2 edd-0.3\n/home/flachman/Projects/psss/edd/tmp/SOURCES/edd-0.3.tar.bz2\n']
Created archive: /home/flachman/Projects/psss/edd/tmp/SOURCES/edd-0.3.tar.bz2

It looks like the parsing went well but the build failed, because we expect to have the archive in the current directory:

12:37:54.443 utils.py          DEBUG  cmd = 'rpmbuild -bs --define _sourcedir . --define _specdir /home/flachman/Projects/psss/edd --define _srcrpmdir /home/flachman/Projects/psss/edd --define _topdir /home/flachman/Projects/psss/edd --define _builddir /home/flachman/Projects/psss/edd --define _rpmdir /home/flachman/Projects/psss/edd --define _buildrootdir /home/flachman/Projects/psss/edd edd.spec'
b'error: Bad source: ./edd-0.3.tar.bz2: No such file or directory'
ERROR    Command ['rpmbuild', '-bs', '--define', '_sourcedir .', '--define', '_specdir /home/flachman/Projects/psss/edd', '--define', '_srcrpmdir /home/flachman/Projects/psss/edd', '--define', '_topdir /home/flachman/Projects/psss/edd', '--define', '_builddir /home/flachman/Projects/psss/edd', '--define', '_rpmdir /home/flachman/Projects/psss/edd', '--define', '_buildrootdir /home/flachman/Projects/psss/edd', 'edd.spec'] failed
ERROR    Command ['rpmbuild', '-bs', '--define', '_sourcedir .', '--define', '_specdir /home/flachman/Projects/psss/edd', '--define', '_srcrpmdir /home/flachman/Projects/psss/edd', '--define', '_topdir /home/flachman/Projects/psss/edd', '--define', '_builddir /home/flachman/Projects/psss/edd', '--define', '_rpmdir /home/flachman/Projects/psss/edd', '--define', '_buildrootdir /home/flachman/Projects/psss/edd', 'edd.spec'] failed.
ERROR    Failed to create SRPM: PackitCommandFailedError("Command ['rpmbuild', '-bs', '--define', '_sourcedir .', '--define', '_specdir /home/flachman/Projects/psss/edd', '--define', '_srcrpmdir /home/flachman/Projects/psss/edd', '--define', '_topdir /home/flachman/Projects/psss/edd', '--define', '_builddir /home/flachman/Projects/psss/edd', '--define', '_rpmdir /home/flachman/Projects/psss/edd', '--define', '_buildrootdir /home/flachman/Projects/psss/edd', 'edd.spec'] failed: Command ['rpmbuild', '-bs', '--define', '_sourcedir .', '--define', '_specdir /home/flachman/Projects/psss/edd', '--define', '_srcrpmdir /home/flachman/Projects/psss/edd', '--define', '_topdir /home/flachman/Projects/psss/edd', '--define', '_builddir /home/flachman/Projects/psss/edd', '--define', '_rpmdir /home/flachman/Projects/psss/edd', '--define', '_buildrootdir /home/flachman/Projects/psss/edd', 'edd.spec'] failed.")
ERROR    Failed to create SRPM.

[lachmanfrantisek]

What do you/we preffer?

• Copy the archive to the root directory.
• Edit the rpmbuild command to accept other location?
• Anything else what can be done to fix that?

[psss]

I think the rpmbuild command should not depend on the archive location. If a full path is provided (and if I understand it correctly this is required by packit) then the archive should be taken from that location. No additional steps (such as moving or copying the archive) should be required. Packit should take care of it.