umarcor/issue-runner

Execute Minimal Working Examples (MWEs) defined in the body of Markdown files or GitHub issues.

---

issue-runner is a toolkit to retrive, set up and run Minimal Working Examples (MWEs). MWEs are defined in markdown files (such as the first comment in a GitHub issue), and external tarball(s)/zipfile(s)/file(s) can be included. It extracts sources to separate files, (optionally) invokes docker, executes the entrypoint, and cleans up.

The main use case for this toolkit is to be added to a GitHub Actions (GHA) workflow in order to monitor the issues in a repository and optionally report status/results by:

• labelling issues as reproducible or fixed?,
• adding a comment to the issue with logs and/or refs to jobs/artifacts,
• and/or making test artifacts available through a CI job

Nonetheless, the CLI tool can also be used to set up and test any MWE or issue locally.

---

issue-runner's Issues

[LCS-2016-001] Partially Connected Vectors on Port Map

Ref LCS page

Allow for vectors to be partially connected in the port map

Minimal Working Example

signal not_so_long_vector : std_logic_vector(15 downto 0);

component Some_Device is
    port (
        long_port : std_logic_vector(31 downto 0)
    );
end component Some_Device;

U1 : Some_Device port map(
    long_port(15 downto 0) => not_so_long_vector,
    long_port(31 downto 16) => open
);

[LCS-2016-006e] Allow access to system environment variables (baseline)

Ref LCS page

Allow access to system environment variables (baseline)

Minimal Working Example

-- Check a configuration file in the user's home directory
use std.env.all;
use std.textio.all;

impure function GetConfig return boolean is
    file config : text;
    variable home, data : line;
    variable result : boolean;
begin
    home := GETENV("HOME");
    assert home /= null report "No HOME environment variable";
    FILE_OPEN(config,
        home.all & DIR_SEPARATOR &
        ".config" & DIR_SEPARATOR &
        "myapp.txt",
        read_mode
    );
    READ_LINE(config, data);
    READ(data, result);
    FILE_CLOSE(config);
    return result;
end function GetConfig;

[LCS-2016-018d] New attributes - 'designated_type

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-002] Allow access and protected type parameters on function interfaces

Ref LCS page

Allow access and protected type parameters on function interfaces

Minimal Working Example

not available yet

[LCS-2016-043] Attributes for PSL

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-059] Array Type Generics

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-071a] Extra optional semicolon at the end of interface_list

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-028] Selected names for types - implementation of external names for types

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-072b] Function Knows Return Vector Size

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-045c] Interface - 'CONVERSE for a mode view

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-004] Allow PT methods with AT and FT parms

Ref LCS page

Allow Protected Type Method Parameters to be Access Types, Protected Types (functions), and File Types

Minimal Working Example

not available yet

[LCS-2016-041] Record Introspection / Type Reflection

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-082] Syntax regularization: empty records

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-018] Attributes for Enumerated Types

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-011] Date/Time functions

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-006a] File IO / Textio updates

Ref LCS page

Add new sub programs for file I/O

Minimal Working Example

not available yet

[LCS-2016-030] Garbage Collection

Ref LCS page

empty body

Minimal Working Example

not available yet

Update section 'Create a new release branch' of the README

Since a bundler (webpack) is used now, creation of new release branches is easier. Only four files need to be published (README.md, action.yml, main.js, and main.js.map). Instructions should be updated accordingly. I.e., there is no need to remove items explicitly (git rm -rf *.json *config.js *.lock .github .gitignore .v0 __tests__ src examples cli.sh); it should be remove everything except 'dist'.

[LCS-2016-045a] Interface - defines new mode view construct for composite interface objects

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-015a] ReportCallingPath - Current File and Line by function

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-014] Composites of Protected Types

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-023] Relax Library Requirement on Configurations

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-034] Protected Types with Generic Clause

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-012] 'IMAGE and TO_STRING for composite types

Ref LCS page

empty body

Minimal Working Example

not available yet

[test] ghdl/ghdl#579

entity ent is
  generic (
    max : natural);
  port (
    p : out natural range 1 to max := 3);
end entity;

architecture a of ent is
begin
end;

entity ent2 is
end entity;

architecture a of ent2 is
  constant max : natural := 2;
  signal p : natural range 1 to max;
begin

  inst : entity work.ent
    generic map (max => max)
    port map (p => p);
end;

ghdl --version
ghdl -a ent.vhd
ghdl -a ent2.vhd
ghdl --elab-run ent2

Python 2.x compatible extract_sources.py

When testing this (time = NOW) on https://labs.play-with-docker.com, I had to 'downgrade' the script to python2 in order to run. Patch attached.

Full description to start playing:

1. copy original extract_sources.py (commit 2cdc15e) to $HOME
2. Copy extract_sources.patch.gz to same dir
3. run 'patch -p0 < extract_sources.patch'
4. Execute runner.sh as usual

[LCS-2016-015] Report Calling Path

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-055a] Syntax regularization - component declarations

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-007] Sequential Declaration Regions

Ref LCS page

Sequential Declaration Regions

Minimal Working Example

not available yet

[LCS-2016-033] Composition with Protected Types

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-007a] Sequential Declaration Regions - corresponding short form

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-086] All Interface Lists Can Be Ordered

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-059a] Allow ordering on any scalar array - related to Array Type Generics

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-006c] File IO / Directory I/O

Ref LCS page

TextIO additions

Minimal Working Example

not available yet

[LCS-2016-018a] New attributes - 'index

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-016] Anonymous Types

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-049] Map Generics On Subprogram Call

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-014a] Pointers to Composites of Protected Types

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-026c] LongIntegers

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-032] PATH_NAME and Shared Variables and Subprograms

Ref LCS page

empty body

Minimal Working Example

not available yet

Test issue

This is the body of a test issue

#!/usr/bin/env sh
env

#:file: run

[LCS-2016-050] API for Assert

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-075] Closely related record types

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-047] Protected Type: Shared Variables On Entity Interface

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-019] Inferring Constraints from Initial Values for Signals and Variables

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-036a] Allow for conditional expressions in a declaration (baseline)

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-006f] Expose standard conditional analysis identifiers

Ref LCS page

Expose standard conditional analysis identifiers

Minimal Working Example

not available yet

[LCS-2016-094a] Conditional Return Statement

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-070] Bidirectional Connections

Ref LCS page

empty body

Minimal Working Example

not available yet

[LCS-2016-061] Conditional compilation

Ref LCS page

empty body

Minimal Working Example

not available yet