Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Dmitri Popov <[email protected]>
  • Loading branch information
dcermak and dmpop committed Sep 4, 2024
1 parent 2076e26 commit 20d987e
Showing 1 changed file with 14 additions and 18 deletions.
32 changes: 14 additions & 18 deletions src/bci_build/package/osc/README.md.j2
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

{% include 'badges.j2' %}

This is the openSUSE packaging container image, it includes all the necessary
software to create and modify packages in the [Open Build
This is the openSUSE packaging container image that includes all the required
tools for creating and modifying packages in the [Open Build
Service](https://build.opensuse.org/) using
[osc](https://github.com/openSUSE/osc/).


## How to use this container image

This container image is intended for interactive usage with your `.oscrc` and
The container image is intended for interactive usage with a `.oscrc` configuration file and
the osc cookiejar mounted into the container:

```ShellSession
Expand All @@ -20,8 +20,7 @@ the osc cookiejar mounted into the container:
{{ image.pretty_reference }}
```

The above command launches an interactive shell where your local osc config will
be used. You can then proceed to checkout packages, perform modifications and
The command launches an interactive shell environment that uses the local osc configuration. You can then check out packages, perform modifications, and
send submissions to OBS.

To work on an already checked out package, mount the current working directory:
Expand All @@ -35,8 +34,8 @@ To work on an already checked out package, mount the current working directory:
```

The container entrypoint recognizes whether you are launching it for interactive
usage or whether you are invoking `osc` directly. For convenience, you can omit
the command `osc` in the second case. E.g.:
usage or invoking `osc` directly. You can omit
the command `osc` in the second case. For example:

```ShellSession
# podman run --rm -it \
Expand All @@ -45,24 +44,22 @@ the command `osc` in the second case. E.g.:
{{ image.pretty_reference }} ls openSUSE:Factory
```

The above command will automatically forward the arguments to `osc` and call
The command automatically forwards the arguments to `osc` and calls
`osc ls openSUSE:Factory`.


### Using the image labels

The image provides two labels `run` and `runcwd` which include the full command
to run the `osc` container or run it with the local working directory mounted as
well.
The image provides two labels: `run` and `runcwd`. The first includes the full command, to run the `osc` container, while the second to run the container with the local working directory mounted.

These labels can be shown via:
To view the labels, use the following command:

```ShellSession
# podman container runlabel run --display {{ image.pretty_reference }}
# podman container runlabel runcwd --display {{ image.pretty_reference }}
```

The labels can be used to run the container with podman version 5.1.0 or later:
The labels can be used to run the container with Podman version 5.1.0 or later:
```ShellSession
# podman container runlabel run {{ image.pretty_reference }} \
ls openSUSE:Factory
Expand All @@ -71,9 +68,8 @@ The labels can be used to run the container with podman version 5.1.0 or later:

### Connecting to build.suse.de

build.suse.de uses a ssh based authentication and thus requires additional
resources to be available in the container. Additionally, you have to provide
the internal certificate to the container as well:
build.suse.de uses an SSH-based authentication, which requires additional
resources to be available in the container. You also must provide the internal certificate to the container:

```ShellSession
# podman run --rm -it \
Expand All @@ -89,8 +85,8 @@ the internal certificate to the container as well:

## Limitations

- It is currently not possible to build packages in a container.
- The `runlabel run` command only works with podman 5.1.0 and newer.
- Currently, it is not possible to build packages in a container.
- The `runlabel run` command only works with Podman 5.1.0 and newer.


## Volumes
Expand Down

0 comments on commit 20d987e

Please sign in to comment.