[[!meta title="Iteration planning: April 24 – May 7"]] [[!meta date="Sat, 23 Apr 2022 15:30:00 +0100"]] [[!tag meeting]] [[!toc levels=2]] # Assessment of the iteration that has ended [previous iteration]: /blog/2022/04/11/planning We had planned to work on the following issues for the [previous iteration][], and finished them: - [[!issue 221]] -- _Command line tool has insufficient logging_ - [[!issue 282]] _Release Subplot with improved Rust support_ - [[!issue 254]] _Make release 0.3.2 or 0.4.0 of Subplot_ # Repository review We reviewed the open issues, merge requests, and CI pipelines for all the projects in the Subplot group on gitlab.com. ## The `subplot` repository There were 50 open issues and we opted to review them all as we are at the start of a goal. - [[!issue 16]] _Error messages should say where in the source the problem was found_ we removed the `someday-maybe` label and brought it into the goal. - [[!issue 96]] _Error for "do not understand binding" should say in which file…_ we brought into the goal. - [[!issue 207]] _Release process is too manual, …_ we decided to close which also resulted in us closing [[!issue 218]] - [[!issue 220]] _Generated Rust test programs are hard to debug_ we close to close because it's much easier to debug these now, and if we need to improve matters in the future we can make a new issue with the specific improvements we suggest. - [[!issue 223]] _lib/runcmd lacks a generic "given an installed {name}" step_ Lars added some commentary, as we continue to try and work out what this truly means for us. - [[!issue 227]] _Doesn't support a workflow where codegen is used from build.rs_ is actually now done, so we closed this. - [[!issue 235]] _The Subplot subplot (`subplot.md`) is too long_ we removed the `someday-maybe` label and brought it into the goal - [[!issue 255]] _Should use "diagram" instead of "graph" for plantuml etc_ we removed `someday-maybe`, assigned it to Lars, and brought it tentatively into the iteration - [[!issue 256]] _Lacks way to mark an embedded file as being OK that it's not used in a scenario_ we removed `someday-maybe`, assigned it to Daniel, and brought it tentatively into the iteration - [[!issue 260]] _Could use pandoc-filter-diagram crate_ we closed because goal 3 will be moving us away from pandoc-ast and so the crate is not relevant for Subplot - [[!issue 276]] _Lacks an HTTP client step library_ we added the `someday-maybe` label. - [[!issue 281]] _Parsing markdown with Pandoc doesn't handle basedir_ will need revisiting when we've redone our internal data formatting etc. but we added the `bug`, and `docgen` labels, and brought it into the goal. We then reexamined [[!issue 246]] _Split off document YAML metadata into a separate file_ and created [[!issue 283]] to encapsulate just the YAML split out which we assigned to Lars and tentatively added to the iteration. There are no open merge requests. There were open, old branches: - `docgen-cmark` -- we will keep this until the next goal is finished CI pipelines are OK. ## The `subplot-web` repository There were no open issues, no open merge requests, no extra branches, and no CI enabled. ## The `subplot-container-images` repository There was one open issue. - [subplot-container-images #2](https://gitlab.com/subplot/subplot-container-images/-/issues/2) -- _There is no Docker image for using Subplot_ - we're not going to work on this until we stop making breaking changes There were no open merge requests, no extra branches, and the latest run of CI was successful. (That's the run that was automatically triggered recently.) # Discussion and decisions ## [Recurring agenda items](https://gitlab.com/subplot/subplot/-/issues?sort=updated_desc&state=opened&label_name[]=recurring-agenda-item) - [[!issue 119]] -- _Subplot is in not in Debian unstable_ - we're not going to work on this now - [[!issue 272]] -- _Migrate project to issue-based iteration meetings_ - we're not going to work on this now - [[!issue 273]] -- _Perform whole-codebase review and cleanup_ - we agreed that during goal 3 we may end up making MRs which are related to this, and that we hope by the end of goal 3 to have reviewed at least a large part of the codebase. ## Reaching out for feedback We won't be reaching out for feedback until goal 3 is done. We didn't open issue for this, to avoid naming people in public. # New iteration ## Previous goal The current development goal is: > Subplot provides a set of libraries with identical capabilities in > each of the supported languages. Python remains a supported > language. Rust is promoted to supported-language status. Subplot > will be tested with all supported languages. In addition, any > quality of life improvements which can be done shall be done. This > goal will be considered complete when a release of Subplot has been > made with the unified language handling support complete. This is represented as label [`goal::2`](https://gitlab.com/subplot/subplot/-/issues?sort=created_asc&state=opened&label_name[]=goal::2) in the GitLab.com issue tracker. ## Current goal The current development goal is: > Subplot is altered to treat a YAML document as the root of any subplot > document, permitting multiple markdown files to be joined into a single scenario set > or output document. We remove our dependency on Pandoc's AST for internal > document representation, and support a better range of document metadata as a result. > We will use marked data types where possible to permit better provenance information > in error and warning messages; and we will strive to reenable the reference tests > such that we can make a statement to the effect that post goal 3, we do not _intend_ > to make further breaking changes to the input formats or primary behaviours of Subplot. This is represented as label [`goal::3`](https://gitlab.com/subplot/subplot/-/issues?sort=created_asc&state=opened&label_name[]=goal::3) in the GitLab.com issue tracker. ## Issues for this iteration We collected issues for this iteration in [[!milestone 48]]. - [[!issue 283]] _YAML metadata is not in its own file_, assigned to Lars - [[!issue 256]] _Lacks way to mark an embedded file as being OK that it's not used in a scenario_, assigned to Daniel - [[!issue 255]] _Should use "diagram" instead of "graph" for plantuml etc?_, assigned to Lars ## Releases We decided not to make a release for this iteration # Any other business ## Gitlab approved open source project We jumped through the hoops to request the gitlab open source project privileges. Daniel is the contact for this, we'll see how it goes. Gitlab say it can up to ten days before a decision is reached. # Actions None. # Meeting participants - Lars Wirzenius - Daniel Silverstone