Skip to content

Commit 87956b1

Browse files
committed
📝 further ADR clean up
1 parent 9f08a4f commit 87956b1

File tree

2 files changed

+25
-26
lines changed

2 files changed

+25
-26
lines changed

docs/adr/352-lts-strategy.md

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -19,38 +19,38 @@ has been spread out across multiple issues, repos, slack channels, and meetings.
1919
and generally have agreed on our goals/strategy but we have not officially documented and centralized that. This ADR is
2020
both gathering all that context to one place as well as give concrete decisions and next steps.
2121

22-
### Scope:
22+
### Scope
2323

2424
This ADR applies to, and should cover, all repositories within the Express Projects three orgs (`jshttp`, `pillarjs`,
2525
`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.
2727

28-
### ADR Goals:
28+
### ADR Goals
2929

3030
- Improve documentation on our support goals
3131
- 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
3333
- Improve documentation on how our LTS relates to Node.js version support
3434
- 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
3636
- 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
3838

39-
### ADR Non-Goals:
39+
### ADR Non-Goals
4040

4141
- Create an end-user documentation resource (either for immediate use or future use)
4242
- Commit to future release dates
4343

4444
**Existing issues/discussions/pull requests related to this:**
4545

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>
4949
- 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>
5454

5555
### Package/Repository Types
5656

@@ -85,7 +85,7 @@ requirements:
8585
dependencies, middleware, & tools/other.
8686
- Dropping old Node.js versions *alone* is not enough of a breaking change to release a new major version. Applies to
8787
`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
8989
the TC agrees we are safe cutting support.
9090
- `express` dependency packages will follow the same timeline and support dates for the `express` version which they are
9191
included with.
@@ -125,25 +125,24 @@ ADR and will be addressed in a separate proposal.
125125

126126
For the existing release lines, we will set the following phase dates:
127127

128-
129128
| Major | CURRENT | ACTIVE | MAINTENANCE | EOL |
130129
| ----- | ------- | ------ | ----------- | --- |
131130
| 4.x | | | 2025-04-01 | <sup>[1]</sup> no sooner than 2026-10-01 |
132131
| 5.x | 2024-09-11 | 2025-03-31 | <sup>[2]</sup>TBD | <sup>[2]</sup>TBD |
133132
| 6.x | <sup>[3]</sup>TBD | | | |
134133

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
136135
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
140139
these dates when we commit to them.
141140

142141
### Documentation
143142

144143
The project will maintain two types of documentation for this:
145144

146-
#### Project documentation for the maintainers:
145+
#### Project documentation for the maintainers
147146

148147
This includes this doc, but also detailed things about the process that are not necessary for anyone but us. This
149148
documentation will live in one of two places:
@@ -153,13 +152,13 @@ documentation will live in one of two places:
153152
2. The individual repo/package to which it applies. If an individual package has more detailed or different needs the
154153
docs will live along with the repo as decided by the captains.
155154

156-
#### User documentation:
155+
#### User documentation
157156

158157
This will be produced for the website. While the source content of it may live in other places (for example a repo to
159158
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.
161160

162-
#### Next steps:
161+
#### Next steps
163162

164163
- Update the existing LTS doc with more details from this decision
165164
- Update website pages with more details from this decision

docs/adr/action-pinning.md renamed to docs/adr/366-action-pinning.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# ADR 1396308b-0814-47bd-b8fc-6b3965d31295: GitHub Actions - to pin or not to pin
1+
# ADR 366: GitHub Actions - to pin or not to pin
22

33
## Status
44

5-
Proposed <!-- [Proposed | Accepted | Deprecated] -->
5+
Accepted
66

77
## Submitters
88

0 commit comments

Comments
 (0)