nextcloud / nextcloud/workflow_script

Does the App follow semantic versioning?

Open
#119 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
PHP
Stars
89
Forks
19
Avg merge
6h 38m
Merged PRs (30d)
3

Description

Workflow Script app

Workflow Script app version: 1.9.0

https://github.com/nextcloud/workflow_script/commit/44f73abcda15d2cc0b6e757695002efae61c0afa seems to introduce several breaking changes.

E.g. in Launcher.php the signature of OCA\WorkflowScript\BackgroundJobs\Launcher's constructor changes from

public function __construct(LoggerInterface $logger, ITempManager $tempManager, IRootFolder $rootFolder)

to

public function __construct(ITimeFactory $time, LoggerInterface $logger)

Similarly affected is OCA\WorkflowScript\Operation and more subtly OCA\WorkflowScript\Listener\RegisterFlowOperationsListener where only the interface of the parameter changes.

Do these changes not violate the backwards-compatibility requirement, that is implied by the same major version?

Hence, should version 1.9.0 not have been 2.0.0 instead?

The whole idea of semantic versioning is to avoid code breaks on dependencies. According to the (developer documentation)[https://nextcloudappstore.readthedocs.io/en/latest/developer.html#info-xml], version numbers must follow semantic versioning.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the constructor changes in Launcher.php and the referenced Operation and RegisterFlowOperationsListener classes at commit 44f73abcda15d2cc0b6e757695002efae61c0afa. Compare those changes with the semantic-versioning guidance linked in the issue and the app's release metadata; done means recording whether 1.9.0 is compatible with the stated policy and what versioning or documentation action follows.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
backend, release
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.