openmairie.devtools 1.4.1

CI/CD components for GitLab

See documentation for each component in the templates/ folder.

om-logo specifics

For PNG rendering, Inkskape should be available. On Debian-based OS (Ubuntu, etc)

sudo apt-get install inkscape

For other OS, please visit

https://inkscape.org/en/release

You should have the right font (Caviar Dream) available on your system. Get it there

https://www.fontsquirrel.com/fonts/download/Caviar-Dreams

om-tests

Should be run from the tests folder of your project and allow you to initialize your test environment, to run all tests suites or to run only one tests suite.

om-svnexternals

Install SVN dependencies listed in EXTERNALS.txt.

Should be run from the root of your project. It scans for EXTERNALS.txt files and resolves each entry using the following strategy:

1. GitLab package registry — the SVN URL is parsed to derive a package name and version. If a matching archive exists in the openmairie/framework-openmairie generic package registry, it is downloaded and extracted.

2. SVN export — if no archive is found, a classic svn export --force --ignore-externals is performed and any nested EXTERNALS.txt discovered inside the export is resolved recursively.

Two URL patterns are recognised:

• Externals (externals-- prefixed packages):

  .../externals/fpdf/tags/1.8.5/             → externals--fpdf          1.8.5
  .../externals/pear/pear-core/tags/v1.10.12 → externals--pear--pear-core v1.10.12
  .../externals/om-theme/kied/tags/2.0.0     → externals--om-theme--kied 2.0.0

• Framework (openmairie_exemple) — maps to the single package externals--framework-openmairie. The bundled archive (with resolved sub-externals) is preferred over the bare one:

  .../openmairie_exemple/tags/4.11.0-a16/core → core-bundle.tar.gz then core.tar.gz
  .../openmairie_exemple/tags/4.11.0-a16/lib  → lib-bundle.tar.gz  then lib.tar.gz

Local cache

Downloaded archives are cached locally so subsequent runs are near-instant. The cache directory follows the XDG Base Directory Specification:

$XDG_CACHE_HOME/om-devtools/packages/
# or, when XDG_CACHE_HOME is not set:
~/.cache/om-devtools/packages/

Options

-N, --no-cache

Bypass the local cache and force re-download from the registry. The downloaded archives are still stored in the cache for future use.

Usage

cd /path/to/your/project
om-svnexternals            # normal run (uses cache)
om-svnexternals -N         # force re-download

om-release

Performs the complete release cycle for openMairie PHP applications, replacing the legacy om.releaser package. Should be run from the root of your project.

The workflow has three phases:

1. Prerelease — version bump in VERSION.txt (or dyn/version.inc.php), history file update, documentation link update, framework externals pinning, DB init & SQL file handling, commit.

2. Release — git tag.

3. Postrelease — bump to next development version (.dev0), new history section, framework externals unpinning, new SQL files, commit.

By default all three phases run in sequence. Each phase can also be run independently.

Options

--prerelease

Run the prerelease phase only.

--release

Run the release (tag) phase only.

--postrelease

Run the postrelease phase only.

--no-input

Don’t ask questions, use default values (useful in CI).

-v, --verbose

Verbose mode (debug logging).

Usage

cd /path/to/your/project
om-release                  # full release (prerelease + tag + postrelease)
om-release --prerelease     # prerelease only
om-release --release        # tag only
om-release --postrelease    # postrelease only

om-logo

This command allows you to generate SVG and PNG logo for your openMairie application, according to design’s guideline available here

http://www.openmairie.org/communaute/ressources-graphiques/openmairie-identite-visuelle.pdf

Full documentation is available from the help command

om-logo --help

om-release-notes

Generates a release notes PDF (and CSV) from a GitLab milestone. It fetches all issues attached to the milestone, converts their markdown descriptions (including images) to PDF, and produces a document with a cover page, table of contents, and one section per issue category (evolutions, bugs, others).

Usage

om-release-notes --project openmairie/openXXX --milestone "1.15.0"
om-release-notes --project openmairie/openXXX --milestone "1.15.0" \
    --logo logo.png --output notes.pdf

Full documentation is available from the help command

om-release-notes --help