Skip to content

Commit fb85f50

Browse files
committed
feat: add docs for build in-obs
1 parent eec2a5a commit fb85f50

File tree

3 files changed

+61
-0
lines changed

3 files changed

+61
-0
lines changed

authors.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,9 @@ amulhern:
5050
5151
url: https://github.com/mulkieran
5252
image_url: https://github.com/mulkieran.png
53+
54+
rxbryan:
55+
name: Bryan Elee
56+
57+
url: https://github.com/rxbryan
58+
image_url: https://github.com/rxbryan.png

docs/cli/build/in-obs.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: in-obs
3+
date: 2024-06-27
4+
sidebar_position: 5
5+
---
6+
7+
# `packit build in-obs`
8+
9+
Submit a build of the present content in the upstream or local repository to [OBS](https://build.opensuse.org/).
10+
11+
## Requirements
12+
13+
* SPEC file for the project placed in the repository.
14+
* Packit config file placed in the repository.
15+
16+
17+
18+
## Tutorial
19+
20+
1. [Place a config file for packit in the root of your upstream repository.](/docs/configuration/)
21+
22+
2. The command below would create a SRPM from the present content of a repo and perform `osc commit` with it.
23+
:::note
24+
You should specify a project `--project` else a project name in this form `home:<me>:packit` would be used. Don't expect to see that project on your [OBS](https://build.opensuse.org/) account .
25+
:::
26+
```
27+
$ cd my/ustream/project/
28+
$ packit build in-obs --project <project_name>
29+
```
30+
31+
## Help
32+
33+
Usage: packit build in-obs [OPTIONS] [PATH_OR_URL]
34+
35+
Build selected project in OBS
36+
37+
Options:
38+
--owner TEXT OBS user, owner of the project. (defaults to the
39+
username from the oscrc)
40+
--project TEXT Project name to build in. It will be created if does
41+
not exist. It defaults to home:$owner:packit:$pkg
42+
--targets TEXT Comma separated list of chroots to build in. (defaults
43+
to 'fedora-rawhide-x86_64')
44+
--description TEXT Description of the project to build in.
45+
--upstream-ref TEXT Git ref of the last upstream commit in the current
46+
branch from which packit should generate patches (this
47+
option implies the repository is source-git).
48+
--wait / --no-wait Wait for the build to finish
49+
-p, --package TEXT Package to build, if more than one available, like in a
50+
monorepo configuration. Use it multiple times to select
51+
multiple packages.Defaults to all the packages listed
52+
inside the config.
53+
-h, --help Show this message and exit.

docs/cli/build/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Subcommand that groups all RPM build related commands together.
1616
* [`in-mock`](/docs/cli/build/in-mock)
1717
* [`in-copr`](/docs/cli/build/in-copr)
1818
* [`in-koji`](/docs/cli/build/in-koji)
19+
* [`in-obs`](/docs/cli/build/in-obs)
1920
* [`in-image-builder`](/docs/cli/build/in-image-builder)
2021

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

0 commit comments

Comments
 (0)