Skip to content

Commit d48dfbf

Browse files
committed
Run prettier - it now applies beyond code files
1 parent e806a64 commit d48dfbf

File tree

9 files changed

+282
-306
lines changed

9 files changed

+282
-306
lines changed

CONTRIBUTING.md

+99-101
Large diffs are not rendered by default.

README.md

+14-16
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,20 @@
1616

1717
With Ember, you get all of these things:
1818

19-
* [**A Welcoming Community**](https://emberjs.com/community/) - Get the help you need, when you need it.
20-
* [**An Enduring Foundation for your Apps**](https://en.wikipedia.org/wiki/Ember.js) - There are apps that used the first version of Ember almost a decade ago, and successfully still use Ember today.
21-
* [**Reliability & Security**](https://emberjs.com/releases/) - With regular LTS Releases and 30 weeks of security fixes, you can rely on Ember.js to care about the stability [and security](https://emberjs.com/security/) of your app.
22-
* [**Modern JavaScript**](https://guides.emberjs.com/release/upgrading/current-edition/) - Use modern JavaScript features that you're already familiar with like classes, decorators and generators.
23-
* [**Documentation**](https://guides.emberjs.com) - Rely on top-notch documentation for each Ember version and a team that is focused on the documentation and learning experience.
24-
* [**HTML-first Components**](https://guides.emberjs.com/release/components/introducing-components/) - Start with valid, semantic HTML in your components, and layer in the functionality that you need, as you need it.
25-
* [**Routing**](https://guides.emberjs.com/release/routing/) - Ember routes respect URLs while layering in extra functionality like rendering templates, loading data models, handling actions, and conditionally redirecting.
26-
* [**Data Layer**](https://guides.emberjs.com/release/models/) - Ember Data is a powerful data management tool that comes with Ember apps by default. Want to use something else? We support that, too!
27-
* [**Flexibility**](https://guides.emberjs.com/release/models/customizing-adapters/) Use _**any**_ backend stack with your Ember apps, thanks to the flexibility of adapters and serializers.
28-
* [**Autotracking**](https://guides.emberjs.com/release/in-depth-topics/autotracking-in-depth/) - Ember's reactivity model makes it easier to decide what to automatically update, and when.
29-
* [**Zero Config Apps**](https://guides.emberjs.com/release/configuring-ember/) - With strong defaults, you may never need to configure anything in your app, but the options are there if you need it!
30-
* [**Quality Addon Ecosystem**](https://emberobserver.com/) - high-quality, rated addons with the ability to [search by source code](https://emberobserver.com/code-search?codeQuery=task). Many require no additional configuration, making it easier than ever to supercharge your apps.
31-
32-
33-
34-
Find out more:
19+
- [**A Welcoming Community**](https://emberjs.com/community/) - Get the help you need, when you need it.
20+
- [**An Enduring Foundation for your Apps**](https://en.wikipedia.org/wiki/Ember.js) - There are apps that used the first version of Ember almost a decade ago, and successfully still use Ember today.
21+
- [**Reliability & Security**](https://emberjs.com/releases/) - With regular LTS Releases and 30 weeks of security fixes, you can rely on Ember.js to care about the stability [and security](https://emberjs.com/security/) of your app.
22+
- [**Modern JavaScript**](https://guides.emberjs.com/release/upgrading/current-edition/) - Use modern JavaScript features that you're already familiar with like classes, decorators and generators.
23+
- [**Documentation**](https://guides.emberjs.com) - Rely on top-notch documentation for each Ember version and a team that is focused on the documentation and learning experience.
24+
- [**HTML-first Components**](https://guides.emberjs.com/release/components/introducing-components/) - Start with valid, semantic HTML in your components, and layer in the functionality that you need, as you need it.
25+
- [**Routing**](https://guides.emberjs.com/release/routing/) - Ember routes respect URLs while layering in extra functionality like rendering templates, loading data models, handling actions, and conditionally redirecting.
26+
- [**Data Layer**](https://guides.emberjs.com/release/models/) - Ember Data is a powerful data management tool that comes with Ember apps by default. Want to use something else? We support that, too!
27+
- [**Flexibility**](https://guides.emberjs.com/release/models/customizing-adapters/) Use _**any**_ backend stack with your Ember apps, thanks to the flexibility of adapters and serializers.
28+
- [**Autotracking**](https://guides.emberjs.com/release/in-depth-topics/autotracking-in-depth/) - Ember's reactivity model makes it easier to decide what to automatically update, and when.
29+
- [**Zero Config Apps**](https://guides.emberjs.com/release/configuring-ember/) - With strong defaults, you may never need to configure anything in your app, but the options are there if you need it!
30+
- [**Quality Addon Ecosystem**](https://emberobserver.com/) - high-quality, rated addons with the ability to [search by source code](https://emberobserver.com/code-search?codeQuery=task). Many require no additional configuration, making it easier than ever to supercharge your apps.
31+
32+
Find out more:
3533

3634
- [Website](https://emberjs.com)
3735
- [Guides](https://guides.emberjs.com)

RELEASE.md

+97-102
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ This document is intended for maintainers of Ember.js. It describes the process
1313
Features, bugfixes, deprecations and other PRs are merged primarily to the `main` branch.
1414
These changes should be tagged according to what they are and whether they should be cherry-picked back to a beta, stable, or LTS release, see [Commit Tagging](https://github.com/emberjs/ember.js/blob/main/CONTRIBUTING.md#commit-tagging) in the CONTRIBUTING.md. These tags can also be in PR titles (as they are easier to edit after-the-fact than commit messages).
1515

16-
Changes to `main` are released on every commit to `s3` as `canary`.
17-
Weekly, changes on `main` are released as `alpha` on `npm`.
16+
Changes to `main` are released on every commit to `s3` as `canary`.
17+
Weekly, changes on `main` are released as `alpha` on `npm`.
1818

19-
At least weekly, a contributor looks for changes from `main` that are tagged (and appropriate to be backported) to `beta` and creates a new `beta` release if there are changes.
19+
At least weekly, a contributor looks for changes from `main` that are tagged (and appropriate to be backported) to `beta` and creates a new `beta` release if there are changes.
2020

2121
In a beta cycle, there can be as few as 1 beta release or theoretically as many as needed, depending on the changes that land.
2222

@@ -35,45 +35,39 @@ Rarely, a change is needed on an older version but not needed on main or newer v
3535
1. Cherry-pick (using `git cherry-pick -x`) anything tagged `release` that was merged to main since the last release. To do this, look at merged PRs to find commits. The commit history isn't a good way to find these because it sorts by date, and some commits can be on old PRs that were finally merged. You may have to fix any conflicts. If this is beyond you, you can ask the original contributor to make a pull request to `release`.
3636
1. `git push` to let CI run. You must push changes before running the CHANGELOG generation as it uses the GitHub API to find PRs.
3737
1. Generate Changelog:
38-
```bash
39-
HEAD=release PRIOR_VERSION=v5.10.1-ember-source ./bin/changelog.js | uniq | pbcopy
40-
```
41-
38+
```bash
39+
HEAD=release PRIOR_VERSION=v5.10.1-ember-source ./bin/changelog.js | uniq | pbcopy
40+
```
4241
1. Put the results in `CHANGELOG.md` under a heading for the new point release. Clean up the changelog, see [Producing the CHANGELOG](#producing-the-changelog) for the details.
4342
1. Commit with message:
44-
```
45-
Add v5.10.2 to CHANGELOG for `ember-source`
46-
```
47-
43+
```
44+
Add v5.10.2 to CHANGELOG for `ember-source`
45+
```
4846
1. Update `package.json` version to:
49-
```
50-
5.10.2
51-
```
52-
47+
```
48+
5.10.2
49+
```
5350
1. Commit with message:
54-
```
55-
Release v5.10.2-ember-source
56-
```
57-
51+
```
52+
Release v5.10.2-ember-source
53+
```
5854
1. Tag commit:
59-
```bash
60-
git tag v5.10.2-ember-source
61-
```
62-
55+
```bash
56+
git tag v5.10.2-ember-source
57+
```
6358
1. Push tag:
64-
```bash
65-
git push origin v5.10.2-ember-source
66-
```
67-
59+
```bash
60+
git push origin v5.10.2-ember-source
61+
```
6862
1. Push changes `git push`
6963
1. Cherry-pick changelog commit to `main` branch and to the `beta` branch.
7064
1. Draft release on Github, see [Creating a Release on Github](#creating-a-release-on-github).
7165
1. Wait for CI on the tag and check published to npm with `npm info ember-source`.
7266

7367
#### LTS Point release
7468

75-
Follow the above steps but begin with the `lts-5-8` branch (or whatever the LTS branch you are targeting is).
76-
This branch may need to be created if it does not exist from the tag.
69+
Follow the above steps but begin with the `lts-5-8` branch (or whatever the LTS branch you are targeting is).
70+
This branch may need to be created if it does not exist from the tag.
7771
After release, if it is the latest LTS, tag as LTS with `npm dist-tag add [email protected] lts`.
7872

7973
### Creating a (n-th) beta release
@@ -85,77 +79,76 @@ After release, if it is the latest LTS, tag as LTS with `npm dist-tag add ember-
8579
1. Cherry-pick (using `git cherry-pick -x`) anything tagged `beta` that was merged to main since the last beta. To do this, look at merged PRs to find commits. The commit history isn't a good way to find these because it sorts by date, and some commits can be on old PRs that were finally merged. You may have to fix any conflicts. If this is beyond you, you can ask the original contributor to make a pull request to `beta`.
8680
1. `git push` to let CI run. You must push changes before running the CHANGELOG generation as it uses the GitHub API to find PRs.
8781
1. Generate Changelog
88-
```bash
89-
HEAD=beta PRIOR_VERSION=v5.12.0-beta.1-ember-source ./bin/changelog.js | uniq | pbcopy
90-
```
82+
```bash
83+
HEAD=beta PRIOR_VERSION=v5.12.0-beta.1-ember-source ./bin/changelog.js | uniq | pbcopy
84+
```
9185
1. Put the results in `CHANGELOG.md` under a heading for the new beta release. Clean up the changelog, see [Producing the CHANGELOG](#producing-the-changelog) for the details.
9286
1. Commit with message:
93-
```
94-
Add v5.12.0-beta.2 to CHANGELOG for `ember-source`
95-
```
87+
```
88+
Add v5.12.0-beta.2 to CHANGELOG for `ember-source`
89+
```
9690
1. Update `package.json` version to:
97-
```
98-
5.12.0-beta.2
99-
```
91+
```
92+
5.12.0-beta.2
93+
```
10094
1. Commit with message:
101-
```
102-
Release v5.12.0-beta.2-ember-source
103-
```
95+
```
96+
Release v5.12.0-beta.2-ember-source
97+
```
10498
1. Tag commit:
105-
```bash
106-
git tag v5.12.0-beta.2-ember-source
107-
```
99+
```bash
100+
git tag v5.12.0-beta.2-ember-source
101+
```
108102
1. Push tag:
109-
```bash
110-
git push origin v5.12.0-beta.2-ember-source
111-
```
103+
```bash
104+
git push origin v5.12.0-beta.2-ember-source
105+
```
112106
1. Push changes to branch `git push`
113107
1. Cherry-pick changelog commit to main branch.
114108
1. Draft release on Github, see [Creating a Release on Github](#creating-a-release-on-github).
115109
1. Wait for CI on the tag and check published to npm with `npm info ember-source`.
116110

117-
118111
### Creating a stable release
119112

120-
1. Look for any unreleased changes on `release`. If there are, consider whether there should first be a point release to the old stable version before creating a new stable release.
113+
1. Look for any unreleased changes on `release`. If there are, consider whether there should first be a point release to the old stable version before creating a new stable release.
121114
1. In `ember.js` repo, on main branch, `git pull`.
122115
1. `git checkout beta`. (Note the branch! This is the release train).
123116
1. `git pull`.
124117
1. Cherry-pick (using `git cherry-pick -x`) anything tagged `release` that was merged to main since the last beta release. To do this, look at merged PRs to find commits. The commit history isn't a good way to find these because it sorts by date, and some commits can be on old PRs that were finally merged. You may have to fix any conflicts. If this is beyond you, you can ask the original contributor to make a pull request to `release`.
125118
1. `git push` to let CI run. You must push changes before running the CHANGELOG generation as it uses the GitHub API to find PRs.
126119
1. Generate Changelog. The `PRIOR_VERSION` should be the last beta release of the series.
127-
```bash
128-
HEAD=beta PRIOR_VERSION=v5.12.0-beta.6-ember-source ./bin/changelog.js | uniq | pbcopy
129-
```
120+
```bash
121+
HEAD=beta PRIOR_VERSION=v5.12.0-beta.6-ember-source ./bin/changelog.js | uniq | pbcopy
122+
```
130123
1. Put the results in `CHANGELOG.md` under a heading for the new stable release. Combine the previous `beta` headings into one entry. Clean up the changelog, see [Producing the CHANGELOG](#producing-the-changelog) for the details.
131124
1. Commit with message
132-
```
133-
Add v5.12.0 to CHANGELOG for `ember-source`
134-
```
125+
```
126+
Add v5.12.0 to CHANGELOG for `ember-source`
127+
```
135128
1. Update `package.json` version to:
136-
```
137-
5.12.0
138-
```
129+
```
130+
5.12.0
131+
```
139132
1. Commit with message:
140-
```
141-
Release v5.12.0-ember-source
142-
```
133+
```
134+
Release v5.12.0-ember-source
135+
```
143136
1. Tag commit:
144-
```bash
145-
git tag v5.12.0-ember-source
146-
```
137+
```bash
138+
git tag v5.12.0-ember-source
139+
```
147140
1. Push tag:
148-
```bash
149-
git push origin v5.12.0-ember-source
150-
```
141+
```bash
142+
git push origin v5.12.0-ember-source
143+
```
151144
1. Make the `beta` branch into the `release` branch:
152-
```bash
153-
git co -B release
154-
```
145+
```bash
146+
git co -B release
147+
```
155148
1. Push the new `release` branch:
156-
```bash
157-
git push -f origin release
158-
```
149+
```bash
150+
git push -f origin release
151+
```
159152
1. Cherry-pick changelog commit to main branch.
160153
1. Draft release on Github, see [Creating a Release on Github](#creating-a-release-on-github).
161154
1. Wait for CI on the tag and check published to npm with `npm info ember-source`.
@@ -167,50 +160,51 @@ After release, if it is the latest LTS, tag as LTS with `npm dist-tag add ember-
167160

168161
1. In `ember.js` repo, on main branch, `git pull`.
169162
1. Make a new beta branch:
170-
```bash
171-
git co -B beta
172-
```
163+
```bash
164+
git co -B beta
165+
```
173166
1. Toggle off any features that have not been explicitly toggled on in `packages/@ember/canary-features/index.ts`.
174167
1. Find the `sha` of the last commit common to `main` and the old `beta` branch. This is typically the cherry-pick of the CHANGELOG entry.
175168
1. Generate Changelog. The `PRIOR_VERSION` is that `sha`:
176-
```bash
177-
HEAD=main PRIOR_VERSION=3daedddaafd638a4a6b12e0265df30255d1512e5 ./bin/changelog.js | uniq | pbcopy
178-
```
169+
```bash
170+
HEAD=main PRIOR_VERSION=3daedddaafd638a4a6b12e0265df30255d1512e5 ./bin/changelog.js | uniq | pbcopy
171+
```
179172
1. Put the results in `CHANGELOG.md` under a heading for the new beta release. Clean up the changelog, see [Producing the CHANGELOG](#producing-the-changelog) for the details.
180173
1. Commit with message:
181-
```
182-
Add v5.12.0-beta.1 to CHANGELOG for `ember-source`
183-
```
174+
```
175+
Add v5.12.0-beta.1 to CHANGELOG for `ember-source`
176+
```
184177
1. Update `package.json` version to:
185-
```
186-
5.12.0-beta.1
187-
```
178+
```
179+
5.12.0-beta.1
180+
```
188181
1. Commit with message:
189-
```
190-
Release v5.12.0-beta.1-ember-source
191-
```
182+
```
183+
Release v5.12.0-beta.1-ember-source
184+
```
192185
1. Tag commit:
193-
```bash
194-
git tag v5.12.0-beta.1-ember-source
195-
```
186+
```bash
187+
git tag v5.12.0-beta.1-ember-source
188+
```
196189
1. Push tag:
197-
```bash
198-
git push origin v5.12.0-beta.1-ember-source
199-
```
190+
```bash
191+
git push origin v5.12.0-beta.1-ember-source
192+
```
200193
1. Push changes to branch:
201-
```bash
202-
git push -f origin beta
203-
```
194+
```bash
195+
git push -f origin beta
196+
```
204197
1. Cherry-pick changelog commit to main branch.
205198
1. Update the main branch version to the next version in package.json: `6.0.0-alpha.1` with message `Post-relase version bump`. Remember that versions go to the next major after the `x.12` release per the [Major Version Process RFC](https://rfcs.emberjs.com/id/0830-evolving-embers-major-version-process/).
206199
1. Draft release on Github, see [Creating a Release on Github](#creating-a-release-on-github).
207200

208201
### Producing the CHANGELOG
202+
209203
[Producing the CHANGELOG]: #producing-the-changelog
210204

211205
The CHANGELOG should make sense from the perspective of a user. Remove anything that is not user-facing.
212206
The CHANGELOG entry is typically the PR title, but it can often be rewritten to be more user-friendly.
213-
Also remove the `beta` and `release` tags from the PR titles.
207+
Also remove the `beta` and `release` tags from the PR titles.
214208

215209
Title the CHANGELOG entry with the version and the date of the release in this format: `## v5.11.0 (August 15, 2023)`.
216210

@@ -220,15 +214,16 @@ Title the CHANGELOG entry with the version and the date of the release in this f
220214
1. `[CLEANUP]` entries may or may not be user-facing. This tag is typically used for removals of deprecated features.
221215
1. Collapse multiple PRs that were for the same issue into a single entry: `- [#12345](https://example.org/emberjs/ember.js/pull/12345) / [#67890](https://example.org/emberjs/ember.js/pull/67890) [BUGFIX] Fix an exception thrown only on Tuesdays.`
222216
1. Handle any `[FEATURE]` entries:
223-
1. If the feature is still behind a non-enabled feature flag, remove the entry.
224-
1. If the feature is now enabled by default, add an entry:
225-
1. Find the PRs that contributed to the feature.
226-
1. Link to the RFC that introduced the feature on the RFC website in the entry: `- [#20464](https://github.com/emberjs/ember.js/pull/20464) [FEATURE] Create public import for uniqueId helper per [RFC #659](https://rfcs.emberjs.com/id/0659-unique-id-helper).`
217+
1. If the feature is still behind a non-enabled feature flag, remove the entry.
218+
1. If the feature is now enabled by default, add an entry:
219+
1. Find the PRs that contributed to the feature.
220+
1. Link to the RFC that introduced the feature on the RFC website in the entry: `- [#20464](https://github.com/emberjs/ember.js/pull/20464) [FEATURE] Create public import for uniqueId helper per [RFC #659](https://rfcs.emberjs.com/id/0659-unique-id-helper).`
227221
1. Change `[BUGFIX beta]` `[BUGFIX release]` `[BUGFIX stable]` to `[BUGFIX]`
228222
1. Change `[DEPRECATION beta]` `[DEPRECATION release]` `[DEPRECATION stable]` to `[DEPRECATION]`
229223
1. Handle any other PR or commit tags similarly.
230224

231225
### Creating a Release on Github
226+
232227
[Creating a Release on Github]: #creating-a-release-on-github
233228

234229
1. Go to the [Ember.js releases page](https://github.com/emberjs/ember.js/releases)

0 commit comments

Comments
 (0)