Skip to content

Commit

Permalink
feat: add docs for build in-obs
Browse files Browse the repository at this point in the history
  • Loading branch information
rxbryan committed Jun 26, 2024
1 parent eec2a5a commit fb85f50
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 0 deletions.
6 changes: 6 additions & 0 deletions authors.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,9 @@ amulhern:
email: [email protected]
url: https://github.com/mulkieran
image_url: https://github.com/mulkieran.png

rxbryan:
name: Bryan Elee
email: [email protected]
url: https://github.com/rxbryan
image_url: https://github.com/rxbryan.png
53 changes: 53 additions & 0 deletions docs/cli/build/in-obs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
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.



## Tutorial

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

2. The command below would create a SRPM from the present content of a repo and perform `osc commit` with it.
:::note
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 .
:::
```
$ cd my/ustream/project/
$ packit build in-obs --project <project_name>
```

## Help

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

Build selected project in OBS

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.

0 comments on commit fb85f50

Please sign in to comment.