https://github.com/xmidt-org/rpm-package-action
Provide a simple way to package and sign rpms for different platforms.
https://github.com/xmidt-org/rpm-package-action
Last synced: about 2 months ago
JSON representation
Provide a simple way to package and sign rpms for different platforms.
- Host: GitHub
- URL: https://github.com/xmidt-org/rpm-package-action
- Owner: xmidt-org
- License: apache-2.0
- Created: 2022-01-20T02:37:14.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-28T07:46:27.000Z (12 months ago)
- Last Synced: 2025-03-17T06:48:40.910Z (2 months ago)
- Language: Shell
- Size: 28.3 KB
- Stars: 1
- Watchers: 11
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Github Action - RPM Package Action
This Github Action provides a simple and flexible way to package and sign rpms for different platforms.
## Usage
### Inputs
| Name | Description | Required? | Notes |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ------------------ |
| `path` | The path to the directory containing all the files needed to build the RPM | Yes | |
| `spec` | The spec file to build. The spec file must be located in the `path` above | Yes | |
| `artifacts-token` | The token to use to download private git repos or release objects if present | No | |
| `build-host` | The build host to specify for inclusion into the RPM information | No | |
| `container-registry-user` | The username to login to the container registry with if present | No | |
| `container-registry-url` | If specified, the non-dockerhub container URL. For Github Containers specify 'ghcr.io' | No | |
| `container-registry-token` | The token to use as the password to the container registry with if present | No | |
| `distro` | The distribution to build on and target, or `custom` to provide your own. Default Dockerfiles are in `~/distros`, this value is the filename suffix | No | Default: `custom` |
| `dockerfile-access-token` | The access token if needed to download the dockerfile from a protected repo. | No | |
| `dockerfile-path` | The path from the repo to the file including the filename. | No | |
| `dockerfile-slug` | The Github owner/repo where the dockerfile can be found. Defaults to looking in the present repo unless specified | No | |
| `gpg-key` | The GPG key used to sign the RPM if you want to sign your RPM | No | Also Needs: `gpg-name` |
| `gpg-name` | The GPG key name used to sign the RPM | No | Also Needs: `gpg-key` |
| `output-dir` | The destination directory to place the RPM and SRPM files. | No | Default `output` |
| `target-processor-arch` | The processor arch to override using `rpmbuild`'s `--target` option. | No | |
### Outputs
- None
### Example workflow - use existing docker image from the action
```yaml
name: RPM Package
on: push
jobs:
package_rpm:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Package RPM and SRPM
uses: xmidt-org/rpm-package-action@v1
with:
path: .
spec: example.spec
distro: rocky-8
```
In this example the repo using this workflow contains the files needed to
build the rpm (including the example.spec file). The output will be placed in
the default location of `output` and will not be signed.
### Example workflow - use existing docker image from the action and sign the package
```yaml
name: RPM Package
on: push
jobs:
package_rpm:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Package RPM and SRPM
uses: xmidt-org/rpm-package-action@v1
with:
path: .
spec: example.spec
distro: rocky-8
gpg-key: ${{ secrets.RPM_GPG_PRIVATE_SIGNING_KEY }}
gpg-name: 'My Signing Key'
```
Everything in this example is the same as the one above it except that it is
signed using the GPG private key you provide. **DO NOT SHARE YOUR PRIVATE KEY.**
But do share the public key portion. The `gpg-name` is the name of the key you
are providing and is a known fact that will show up in the final RPM, so it does
not need to be secret.
### Example workflow - use a dockerfile your repo provides
```yaml
name: RPM Package
on: push
jobs:
package_rpm:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Package RPM and SRPM
uses: xmidt-org/rpm-package-action@v1
with:
path: .
spec: example.spec
dockerfile-path: rpm-builder-dockerfile
```
This will look for a file in your repo named `rpm-builder-dockerfile` and use that
to package the rpm in. Your dockerfile needs to have the following two lines:
```
COPY entrypoint.sh /entrypoint.sh
ENTRYPOINT ["/entrypoint.sh"]
```
Beyond that you can use any image you want provided Github is able to download it.
## References
* [RPM Packaging Guide](https://rpm-packaging-guide.github.io/)
* [RPM Site](https://rpm.org)
* [Excellent Presentation](http://pdwaterman.com/wp-content/uploads/2016/08/RPM-ifying-System-Configurations.pdf) that has several valuable solutions to common problems.
## Contribute
See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
## License
This project is released under the [Apache 2.0 license](LICENSE).