[][src]Crate blocked

This macro takes an issue pattern and an optional 'reason'.

When the BLOCKED_GITHUB_API_KEY environment variable is found, or a CI env is detected, this macro will attempt to find the status of the referenced issue. If the issue has been closed blocked will emit a warning containing the optional 'reason'.

Because this requires network access, it is recommended this is only run in CI builds so as to not slow down the edit-run-debug cycle.

// An attribute-like procedural macro is on the todo-list

use blocked::blocked;
blocked!("1", "This code can be removed when the issue is closed");

// The reason is optional

Issue patterns

The following issue specifiers are supported (Github only for now)

  • #423 or 423. Repository and organisation are pulled from the upstream or origin remote if they exist.
  • serde#423 or serde/423 Organisation is pulled from upstream or origin remote if they exist.
  • serde-rs/serde#423 or serde-rs/serde/423
  • http(s)://github.com/serde-rs/serde/issues/423



See the crate documentation