Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions authors.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,9 @@ venefilyn:
email: freya@venefilyn.se
url: https://github.com/Venefilyn
image_url: https://github.com/Venefilyn.png

rxbryan:
name: Bryan Elee
email: rxbryn@gmail.com
url: https://github.com/rxbryan
image_url: https://github.com/rxbryan.png
55 changes: 55 additions & 0 deletions docs/cli/build/in-obs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: in-obs
date: 2024-06-27
sidebar_position: 5
---

# `packit build in-obs`

Submit a build of the present content in the upstream or local repository to [OBS](https://build.opensuse.org/).

## Requirements

* SPEC file for the project placed in the repository.
* Packit config file placed in the repository.
* OBS user account and password needs to be configured in osc configuration file ~/.config/osc/oscrc.
This can be done by running `osc`.


## Tutorial

1. [Place a config file for packit in the root of your upstream repository.](/docs/configuration/)

2. The command below creates a tarball (archive) of your repository and commits it along with the spec file to a package with a name corresponding to your upstream project on [OBS](https://build.opensuse.org/). The project defaults to home:$username:packit. Running packit build in-obs a second time creates a new commit in that package.

```
$ cd my/ustream/project/
$ packit build in-obs --project <project_name>
```
## Help
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure if you know this, but this is being regenerated automatically from the real help message so you don't need to take care of updating.. Also, what you put into the help message can be edited in one place (~ packit project) and is then visible both in the help message and on docs...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The script is here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay so the help section is updated automatically

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we leave the other sections in?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, yes!


Usage: packit build in-obs [OPTIONS] [PATH_OR_URL]

Build selected project in OBS

Before Running this command, your opensuse user account and password needs
to be configured in osc configuration file ~/.config/osc/oscrc. This can be
done by running `osc`.

Options:
--owner TEXT OBS user, owner of the project. (defaults to the
username from the oscrc)
--project TEXT Project name to build in. It will be created if does
not exist. It defaults to home:$owner:packit:$pkg
--targets TEXT Comma separated list of chroots to build in. (defaults
to 'fedora-rawhide-x86_64')
--description TEXT Description of the project to build in.
--upstream-ref TEXT Git ref of the last upstream commit in the current
branch from which packit should generate patches (this
option implies the repository is source-git).
--wait / --no-wait Wait for the build to finish
-p, --package TEXT Package to build, if more than one available, like in a
monorepo configuration. Use it multiple times to select
multiple packages.Defaults to all the packages listed
inside the config.
-h, --help Show this message and exit.
2 changes: 2 additions & 0 deletions docs/cli/build/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Subcommand that groups all RPM build related commands together.
* [`in-mock`](/docs/cli/build/in-mock)
* [`in-copr`](/docs/cli/build/in-copr)
* [`in-koji`](/docs/cli/build/in-koji)
* [`in-obs`](/docs/cli/build/in-obs)
* [`in-image-builder`](/docs/cli/build/in-image-builder)

## Help
Expand All @@ -32,5 +33,6 @@ Subcommand that groups all RPM build related commands together.
in-copr Build selected upstream project in Copr.
in-image-builder Create a VM image in Image Builder.
in-koji Build selected upstream project in Fedora.
in-obs Build selected repository in Open Build Service
in-mock Build RPMs in mock using content of the upstream repository.
locally Create RPMs using content of the upstream repository.