holdenweb / holdenweb/release

Pre-release checks should be plugins

Open
#4 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

The current version, before proceeding, looks for files containing a string specific to holdenweb development practices. Other users will clearly wish to handle their own situations.

The best solution would be to build a plugin system with a simple enough API that each path in the distribution can be examined by each installed plugin. Given a file, plugins are expected to return a go/no-go result for each file. A null plugin would simply return `True`.

Plugins are identified by the `release_` prefix on their names, and must implement a `check(file_path)` function that normally returns `None`, but if the release should not proceed returns a message containing the reason for rejection.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.