Skip to content

Commit f15eee4

Browse files
committed
Update CONTRIBUTING.md
1 parent d046994 commit f15eee4

1 file changed

Lines changed: 11 additions & 51 deletions

File tree

CONTRIBUTING.md

Lines changed: 11 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1125,47 +1125,26 @@ Both scripts require `build/monolithic/barcode.ps` (run `make` first).
11251125

11261126
### OBS (Open Build Service)
11271127

1128-
Distribution packages are built on OBS for 19 targets across DEB, RPM, and
1129-
Arch-based distributions, using two projects:
1128+
Distribution packages are built on OBS for multiple targets across DEB, RPM,
1129+
and Arch-based distributions, using two projects:
11301130

11311131
| Project | Purpose | Source | Version format |
11321132
|-----------------------------------------------------------------------------------------------------------------------------------------|-------------|------------|-------------------------------------|
11331133
| [`home:terryburton:postscriptbarcode`](https://build.opensuse.org/package/show/home:terryburton:postscriptbarcode/libpostscriptbarcode) | **Release** | Pinned tag | `@PARENT_TAG@` |
11341134
| `home:terryburton:postscriptbarcode:dev` | Dev/nightly | HEAD | `@PARENT_TAG@.@TAG_OFFSET@~nightly` |
11351135

1136-
The release project's services run on commit and can be re-triggered via
1137-
`osc service remoterun`. Trigger promptly after tagging, before further
1138-
commits land. The dev project builds from HEAD on each trigger.
1139-
1140-
**How it works:**
1141-
1142-
1. The `_service` file tells OBS to:
1143-
- Fetch the source tarball from the upstream GitHub repository via `tar_scm`
1144-
- Extract the RPM spec, Arch PKGBUILD, and Debian packaging files via
1145-
`extract_file`
1146-
- Set the version via `set_version`
1147-
2. OBS builds packages using each distro's native toolchain
1148-
(`dpkg-buildpackage`, `rpmbuild`, `makepkg`)
1149-
11501136
**Packaging files:**
11511137

1152-
- `debian/` - Debian packaging (must be at
1153-
repo root for `dpkg-buildpackage`)
1138+
- `debian/` - DEB packaging
11541139
- `packaging-examples/rpm-based/postscriptbarcode.spec` - RPM spec file
1155-
- `packaging-examples/arch-linux/PKGBUILD` - Arch PKGBUILD
1156-
- `packaging-examples/open-build-service/` - OBS-specific files
1157-
(`_service.release`, `_service.dev`, `.dsc`, `debtransform`)
1158-
1159-
**Version handling:**
1160-
1161-
The RPM spec and Arch PKGBUILD have empty version fields that OBS's
1162-
`set_version` service fills at build time. The `CHANGES` file line 1 is
1163-
`XXXX-XX-XX` between releases; build scripts (`setup.py`, `Makefile.PL`,
1164-
`libs/c/Makefile`, `libs/bindings/Makefile`) skip this placeholder and use the
1165-
first line starting with a digit.
1140+
- `packaging-examples/arch-linux/PKGBUILD` - Arch packaging
11661141

11671142
**Triggering builds:**
11681143

1144+
The release project's services run on commit and can be re-triggered via
1145+
`osc service remoterun`. Trigger promptly after tagging, before further
1146+
commits land. The dev project builds from HEAD on each trigger.
1147+
11691148
```bash
11701149
# Release
11711150
osc service remoterun home:terryburton:postscriptbarcode libpostscriptbarcode
@@ -1181,30 +1160,11 @@ osc results home:terryburton:postscriptbarcode:dev libpostscriptbarcode
11811160
Post-install smoke tests verify that packages work after installation. Shared
11821161
test scripts in `packaging-examples/install_tests/` run across all distros.
11831162

1184-
**Test scripts:**
1163+
**Package test scripts:**
11851164

1186-
- `run_all.sh` - Top-level runner; exits non-zero on any skip or failure
11871165
- `test_postscript.sh` - Loads `barcode.ps` in GhostScript and generates a barcode
1188-
- `test_clib.sh` - Tests C shared library via python3 ctypes
1189-
- `test_python.sh` - Tests Python binding via installed example
1190-
- `test_perl.sh` - Tests Perl binding via installed example
1191-
- `test_ruby.sh` - Tests Ruby binding via installed example
1192-
- `test_java.sh` - Tests Java binding via jshell or java
1193-
1194-
**Integration layers:**
1195-
1196-
- `debian/tests/` - DEP-8 autopkgtest; triggered by OBS DEB builds and
1197-
Debian's britney2 on dependency updates
1198-
- `.github/workflows/package-install-tests.yml` - GitHub Actions; builds
1199-
packages for DEB, RPM, and Arch, installs them in clean containers, and runs
1200-
the smoke tests
1201-
1202-
**Running locally after a manual package install:**
1203-
1204-
```bash
1205-
packaging-examples/install_tests/run_all.sh
1206-
```
1207-
1166+
- `test_clib.sh` - Compiles and runs C example against installed library
1167+
- `test_<binding>.sh` - Tests binding via installed example
12081168

12091169
## Release Process
12101170

0 commit comments

Comments
 (0)