kontent-ai/delivery-sdk-php

Spike: Make the SDK tracking header load the library version automatically

Open

#54 opened on Feb 1, 2018

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)PHP (13 forks)auto 404
enhancementgroomedhacktoberfesthelp wantedrefactoringup-for-grabs

Repository metrics

Stars
 (46 stars)
PR merge metrics
 (PR metrics pending)

Description

The SDK sends a version tracking header in the following form: X-KC-SDKID: packagist.org;kentico-kontent/delivery-sdk-php;0.9.1 with every request. This was implemented in #43

Currently, the tracking header is hardcoded in the DeliveryClient.php and needs to be updated with every release

The goal of this task is to find a way of updating this version automatically (using a pre/post build action) or loading it from the composer.json somehow (after packagist sets it up during release).

We are open to any other ideas! :-)

Contributor guide

Research direction
Explore ways to automatically load the SDK version from composer.json during runtime, such as using Composer's autoload or a pre build script, to replace the hardcoded version string in the tracking header.
Tech stack
php
Domain
backendapibuild system
Issue type
Research
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PHPComposer
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70