@@ -19,38 +19,38 @@ has been spread out across multiple issues, repos, slack channels, and meetings.
19
19
and generally have agreed on our goals/strategy but we have not officially documented and centralized that. This ADR is
20
20
both gathering all that context to one place as well as give concrete decisions and next steps.
21
21
22
- ### Scope:
22
+ ### Scope
23
23
24
24
This ADR applies to, and should cover, all repositories within the Express Projects three orgs (` jshttp ` , ` pillarjs ` ,
25
25
` expressjs ` ). While everything stems from support for the primary ` express ` package, due to the coupling of many of our
26
- dependency and middleware packages, we must also address those packages as well.
26
+ dependency and middleware packages, we must also address those packages as well.
27
27
28
- ### ADR Goals:
28
+ ### ADR Goals
29
29
30
30
- Improve documentation on our support goals
31
31
- Document criteria and reasoning for when to release new majors
32
- - Define life cycle for releases, terminology we will use,
32
+ - Define life cycle for releases and terminology we will use
33
33
- Improve documentation on how our LTS relates to Node.js version support
34
34
- Documentation on how our LTS relates to our direct dependencies and other Express project repos/packages
35
- - Set clear next steps for documenting and publicising the LTS strategy
35
+ - Set clear next steps for documenting and publicizing the LTS strategy
36
36
- Select dates for known release line support and EOL
37
- - Create starter language and graphics for our future blog posts, website additions, and other necessary docs
37
+ - Create starter language and graphics for our future blog posts, website additions, and other necessary docs
38
38
39
- ### ADR Non-Goals:
39
+ ### ADR Non-Goals
40
40
41
41
- Create an end-user documentation resource (either for immediate use or future use)
42
42
- Commit to future release dates
43
43
44
44
** Existing issues/discussions/pull requests related to this:**
45
45
46
- - Initial LTS strategy doc: https://github.com/expressjs/discussions/blob/master/docs/LTS-strategy.md
47
- - Additional LTS doc proposal: https://github.com/expressjs/admin/pull/3
48
- - https://github.com/ctcpip/express-release
46
+ - Initial LTS strategy doc: < https://github.com/expressjs/discussions/blob/master/docs/LTS-strategy.md >
47
+ - Additional LTS doc proposal: < https://github.com/expressjs/admin/pull/3 >
48
+ - < https://github.com/ctcpip/express-release >
49
49
- Some other related discussions:
50
- - https://github.com/expressjs/discussions/issues/196
51
- - https://github.com/expressjs/discussions/issues/172
52
- - https://github.com/expressjs/discussions/issues/67
53
- - TC Slack Discussion: https://openjs-foundation.slack.com/archives/C06KMCETHG9/p1724863852681889
50
+ - < https://github.com/expressjs/discussions/issues/196 >
51
+ - < https://github.com/expressjs/discussions/issues/172 >
52
+ - < https://github.com/expressjs/discussions/issues/67 >
53
+ - TC Slack Discussion: < https://openjs-foundation.slack.com/archives/C06KMCETHG9/p1724863852681889 >
54
54
55
55
### Package/Repository Types
56
56
@@ -85,7 +85,7 @@ requirements:
85
85
dependencies, middleware, & tools/other.
86
86
- Dropping old Node.js versions * alone* is not enough of a breaking change to release a new major version. Applies to
87
87
` express ` , dependencies, middleware, & tools/other.
88
- - ` express ` version 4.x is considered a special case. It will receive a longer ` MAINTENENCE ` phase of 18 months or until
88
+ - ` express ` version 4.x is considered a special case. It will receive a longer ` MAINTENANCE ` phase of 18 months or until
89
89
the TC agrees we are safe cutting support.
90
90
- ` express ` dependency packages will follow the same timeline and support dates for the ` express ` version which they are
91
91
included with.
@@ -125,25 +125,24 @@ ADR and will be addressed in a separate proposal.
125
125
126
126
For the existing release lines, we will set the following phase dates:
127
127
128
-
129
128
| Major | CURRENT | ACTIVE | MAINTENANCE | EOL |
130
129
| ----- | ------- | ------ | ----------- | --- |
131
130
| 4.x | | | 2025-04-01 | <sup >[ 1] </sup > no sooner than 2026-10-01 |
132
131
| 5.x | 2024-09-11 | 2025-03-31 | <sup >[ 2] </sup >TBD | <sup >[ 2] </sup >TBD |
133
132
| 6.x | <sup >[ 3] </sup >TBD | | | |
134
133
135
- 1 . v4 is a special case, and we may extend MAINTENENCE support. This date is called out to give users confidence we will
134
+ 1 . v4 is a special case, and we may extend MAINTENANCE support. This date is called out to give users confidence we will
136
135
not end-of-life * earlier* than this date.
137
- 2 . v5 MAINTENENCE and EOL dates are determined by when v6 is released. We will update them when v6 release dates are
138
- committed to.
139
- 3 . v6 work has not started yet. The earliers we could choose to release by this proposal is 2026-01-01. We will update
136
+ 2 . v5 MAINTENANCE and EOL dates are determined by when v6 is released. We will update them when v6 release dates are
137
+ committed to.
138
+ 3 . v6 work has not started yet. The earliest we could choose to release by this proposal is 2026-01-01. We will update
140
139
these dates when we commit to them.
141
140
142
141
### Documentation
143
142
144
143
The project will maintain two types of documentation for this:
145
144
146
- #### Project documentation for the maintainers:
145
+ #### Project documentation for the maintainers
147
146
148
147
This includes this doc, but also detailed things about the process that are not necessary for anyone but us. This
149
148
documentation will live in one of two places:
@@ -153,13 +152,13 @@ documentation will live in one of two places:
153
152
2 . The individual repo/package to which it applies. If an individual package has more detailed or different needs the
154
153
docs will live along with the repo as decided by the captains.
155
154
156
- #### User documentation:
155
+ #### User documentation
157
156
158
157
This will be produced for the website. While the source content of it may live in other places (for example a repo to
159
158
produce an image for the schedule), the users will be directed to the website to view the current updated version. This
160
- will also co-locate with documentation about Node.js support and other related support content.
159
+ will also co-locate with documentation about Node.js support and other related support content.
161
160
162
- #### Next steps:
161
+ #### Next steps
163
162
164
163
- Update the existing LTS doc with more details from this decision
165
164
- Update website pages with more details from this decision
0 commit comments