dolismartmaker / dolinews-client

v1.0.1 2026-10-08 05:41 UTC

Requires

• php: >=8.1
• ext-curl: *
• ext-json: *
• ext-mbstring: *

AGPL-3.0-or-later

• release
• Announcement
• Dolibarr
• dolinews

Published on Packagist.org on 2026-10-08 05:59 UTC

README

Command line client to submit the announcements and project sheets of a Dolibarr module to DoliNews. PHP alone is enough: the client has no Composer dependency.

This repository is a read-only copy of the client/ directory of dolismartmaker/dolinews. Issues and pull requests go there.

Installation

In the module, as a development dependency:

composer require --dev dolismartmaker/dolinews-client

In a CI job that should not install the whole vendor/ of the module:

composer global require dolismartmaker/dolinews-client
export PATH="$(composer global config bin-dir --absolute --quiet):$PATH"

Commands

php vendor/bin/publish-article.php --init docs/dolinews.md --module=.  # skeleton
php vendor/bin/publish-article.php docs/dolinews.md --check            # no network
php vendor/bin/publish-article.php docs/dolinews.md                    # submission
vendor/bin/check-annonce-version.sh docs/dolinews.md 1.4.0             # header matches the tag
php vendor/bin/draft-from-changelog.php ChangeLog.md docs/dolinews.md  # draft from a ChangeLog section
php vendor/bin/publish-project-sheet.php fiche.md                      # project sheet

Each PHP command prints its full usage with --help.

A token grants the right to submit, never to publish: whatever the client sends lands in the review queue.

Featured image of an announcement

image: in the header of an announcement names the image the feed card, the sharing card and the feeds show for it, by a path relative to the file; image_alt: gives its alternative text. It is reviewed with the article. Without it, the first image of the body is shown. A translation shows the image of its source and names none. A correction (--revise) may change it, and may bring new images in its body: both appear once the review has applied the correction.

Project sheet images

The header of a sheet file may carry a logo and a screenshot gallery, paths relative to the sheet file, one gallery line per image, the caption (255 characters at most) after |:

logo: images/logo.png
gallery: screenshots/accueil.png | Page d'accueil du module
gallery: screenshots/liste.png | Liste des relances

--check verifies each file offline: present, readable, a bitmap image (SVG is refused), caption within its limit. An image is recognised by the sha256 of the file itself: one already on the sheet is not uploaded again, so the command can be run again without duplicates, and --dry-run lists what would be sent. An image removed from the file stays on the sheet. The instance bounds the gallery, ten images by default.

A Dolibarr screenshot almost always carries real data (third parties, amounts, addresses), and the service publishes it as sent: publish screenshots taken on demonstration data only.

Environment

• DOLINEWS_API_TOKEN: personal token of the contributor account, required to submit
• DOLINEWS_API_BASE: API root, to aim another instance (default https://dolinews.com/api/v1)

CI examples

examples/ci-gitlab.yml and examples/ci-github.yml announce a release when it is tagged; examples/annonce.md is a complete announcement file.

License

AGPL-3.0-or-later, see LICENSE.