Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make guide service centric #499

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
2 changes: 1 addition & 1 deletion content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,6 @@ and create [Bodhi](https://bodhi.fedoraproject.org) updates! [Learn more.](/docs
[install locally](/docs/guide/#have-packit-tooling-installed-locally)
and start using right away,

2. a [service]({{< ref "packit-service" >}}), which provides you feedback
2. a [service]({{< ref "guide" >}}), which provides you feedback
on how is your project integrated with [Fedora Linux](https://getfedora.org), [CentOS Stream](https://www.centos.org/centos-stream/)
and other distributions.
66 changes: 64 additions & 2 deletions content/docs/CLI/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,70 @@ bookCollapseSection: true

# Packit CLI

To install [packit CLI](https://github.com/packit/packit)
follow [our guide](/docs/guide/#have-packit-tooling-installed-locally).
## Installation

There are various ways how to install [packit CLI](https://github.com/packit/packit).
Pick what suits you the best:

### Fedora Linux

$ sudo dnf install packit

### Red Hat Enterprise Linux or CentOS Stream 8

On RHEL/CentOS 8 you can install RPM from [EPEL](https://fedoraproject.org/wiki/EPEL) repository.
On CentOS, some dependencies are in PowerTools repository, so you have to enable it:

$ sudo dnf install dnf-plugins-core epel-release
$ sudo dnf config-manager --set-enabled powertools
$ sudo dnf install packit

### Via Fedora COPR

You can also help us test the latest development snapshot by installing packit
built from the main branch in Copr:

$ sudo dnf copr enable packit/packit-dev
$ sudo dnf install packit
$ # OR in case you have packit already installed from the Fedora repositories:
$ sudo dnf upgrade packit

### From PyPI

We publish packit to PyPI and it's available as `packitos` project — **packit
at PyPI is something different**.

$ pip install --user packitos

### From Source

... or installing it directly from GitHub:

$ pip install --user git+https://github.com/packit/packit

### In a container

If none of the above work for you, try running it in a container
from our Fedora based image. It contains packit installed from `main` branch,
i.e. the same you'd get by pip installing from Github.

$ podman run -ti --rm -v $PWD:/src:z quay.io/packit/packit bash
$ packit
Usage: packit [OPTIONS] COMMAND [ARGS]...

Depending on the command you want to perform you need to mount secrets and
configuration files, like in the following examples:

#### Copr build

$ podman run -ti --rm -v ~/.config/copr:/root/.config/copr:z -v $PWD:/src:z quay.io/packit/packit bash
$ packit build in-copr

#### Koji build

$ podman run -ti --rm -v ~/.ssh/:/root/.ssh:z -v $PWD:/src:z quay.io/packit/packit bash
$ fkinit -u <Fedora Account username>
$ packit build in-koji
lachmanfrantisek marked this conversation as resolved.
Show resolved Hide resolved

## Commands

Expand Down
1 change: 0 additions & 1 deletion content/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ bookCollapseSection: true

* [About]({{< ref "about" >}}) - Key principles of Packit.
* [Onboarding Guide]({{< ref "guide" >}}) - How to start using Packit.
* [Packit Service]({{< ref "packit-service" >}}) - GitHub App that helps you continuously ensure that your project work in Fedora OS.
Copy link
Contributor

Choose a reason for hiding this comment

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

This link is still valid, is it not? So it should probably be kept here.

Copy link
Member Author

Choose a reason for hiding this comment

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

But it's a duplicate of the one above. (There are no longer two pages.)

* [Testing Farm]({{< ref "testing-farm" >}}) - Guide to Packit's service for running tests.
* [Frequently Asked Questions]({{< ref "faq" >}}) - Whys, Whats, contacts.
* [Source-git](/docs/source-git/) - Source-git concept and how to work with it.
Expand Down
13 changes: 0 additions & 13 deletions content/docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,8 @@ You should place the file in the root of your upstream repo. Packit accepts thes

* `.packit.yaml`
* `.packit.yml`
* `.packit.json`
* `packit.yaml`
* `packit.yml`
* `packit.json`

Both Packit Service and packit tool use this configuration file.

Expand Down Expand Up @@ -816,14 +814,3 @@ them in a public (such as a GitHub repository). The configuration file here is
located on your workstation, please do NOT confuse it with a config file for
your project - that one is described above in the first section of this
document.

#### Server-side configuration

These values are used to configure packit service. No need to bother with them, they serve as a documentation for us, packit service developers.

Key name | Type | Description
------------------------------|-----------------|----------------------------------------------------------------------
`keytab_path` | string | path to a Kerberos keytab file (requires `fas_user` to be set)
`github_app_id` | string | github app ID used for authentication
`github_app_cert_path` | string | path to a certificate associated with a github app
`webhook_secret` | string | when specified in a Github App settings, GitHub uses it to create a hash signature with each payload
Loading