summaryrefslogtreecommitdiff
path: root/blog/2022/06/18/planning.mdwn
blob: d94a0b7d2a1317ff204d4a3dc3703a1d3b176866 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
[[!meta title="Iteration planning: June 18 – July 2"]]
[[!meta date="2022-06-18 13:50:00 +0100"]]
[[!tag meeting]]

[[!toc levels=2]]

# Actions from last time

- Daniel to ping GitLab.com about making Subplot an approved open
  source project. **DONE**
- Daniel to review his marked Markdown/YAML approach and make a plan
  for getting into a state where Subplot can use it. **DONE**
- Lars to add an Ikiwiki shortcut for referring to the new group level
  milestones. **DONE**
- Lars to reach out to Hillel Wayne about having a look at Subplot.
  **DONE**

# Assessment of the iteration that has ended

[previous iteration]: /blog/2022/05/07/planning

We had planned to work on the following issues for the [previous
iteration][], and finished them:

- [[!containerissue 3]] -- _Remove 1.48 from the container_
- [[!subplotissue 284]] -- _Switch to using clap3 and derive…_

We didn't finish this issue:

- [[!subplotissue 283]] -- _YAML metadata is not in its own file_
  - No progress on this

Lars was very busy with real-life during this extended iteration,
and Daniel was mostly focussed on `marked-data` related prep work.

# 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 45 open issues and we opted to review everything, including
those tagged `someday-maybe`.

- We linked [[!subplotissue 186]] to [[!subplotissue 36]]
- [[!subplotissue 223]] - We removed `actively-discussed` and added
  `someday-maybe` as while we both agree this would be useful, we're
  still not sure exactly what we need, nor if we want it.
- [[!subplotissue 232]] - _Windows and macos…_ we dropped `actively-discussed`
  and added `someday-maybe` as while we know what we need to do, we lack
  Windows or macos systems to do it with for now.
- We linked [[!subplotissue 138]] to [[!subplotissue 267]] as both
  are related to stdin handling in runcmd and made 267 `someday-maybe`.
- [[!subplotissue 283]] -- _YAML metadata is not…_ we added the label for
  the current goal.
- [[!subplotissue 286]] -- _Tests sometimes fail_ was new this iteration.
  Lars encountered it with Ick builds, it's not easily reproduced and
  we have filled a bunch of speculation and notes into the issue.
  We tentatively added this to the iteration, assigned to Lars.

There are no open merge requests.

There is one open, old branch:

- `docgen-cmark` -- _prototype to use another Markdown parser_
  - Lars wants keep this until the current 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

Additionally, Daniel pointed out that our Docker image has an extra
version of Rust included. He created [[!containerissue 3]] to get this
fixed.

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

## Group level milestones

We decided to use GitLab's group level milestones.

## [Recurring agenda items](https://gitlab.com/subplot/subplot/-/issues?sort=updated_desc&state=opened&label_name[]=recurring-agenda-item)

- [[!subplotissue 119]] -- _Subplot is in not in Debian unstable_
  - we're not going to work on this until we are done with goal 3
- [[!subplotissue 272]] -- _Migrate project to issue-based iteration meetings_
  - We won't make this change without other contributors
  - But we filed [[!webissue 3]] to cover a need to document current iteration
    meeting activity so that newcomers can understand what we currently do.
    We added that to the iteration, assigned to Daniel.
- [[!subplotissue 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 code base.

## 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

## 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 [[!ms 1]].

- [[!subplotissue 283]] -- _YAML metadata is not in its own file_
  - assigned to Lars
- [[!webissue 3]] -- _Document how we do meetings_
  - assigned to Daniel
- [[!subplotissue 286]] -- _Tests sometimes fail_
  - assigned to Lars

## Releases

We decided not to make a release for this iteration. We will make a
release after the YAML metadata loading change is done.

# Any other business

## Gitlab approved open source project

We achieved access to the OSS SaaS plan, and as such we need to review
this in early April 2023 in order that we do not expire our subscription
which would happen on May 13th 2023.

We need to remember that if one of the team decides to try and do consultancy
around Subplot, we may have to review our membership of the OSS SaaS plan.

# Actions

- Lars will reach out to Hillel Wayne once more during this iteration.

# Meeting participants

- Daniel Silverstone
- Lars Wirzenius