You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit ce272ae
Browse filesBrowse the repository at this point in the historyBrowse files
#6178 adds .github/release.yml with labels applied automatically from PR
titles, and creates GitHub releases as drafts. Drop this PR's simpler
release.yml so the two don't conflict, and update RELEASING.md to match:
labels come from the title, and the release step is to edit and publish
the draft.
Move the Releases section to the end of CONTRIBUTING.md so it doesn't
conflict with the PR title section #6178 adds.
Signed-off-by: mday-io <mdaytn@gmail.com>
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,10 +87,10 @@ Optionally, `make install-pre-commit` installs git hooks so ruff and mypy run on
87
87
- Include a DCO sign-off on all commits (`git commit -s`)
88
88
- Be responsive to review feedback from maintainers
89
89
90
-
## Releases
91
-
92
-
Maintainers publish releases. See [RELEASING.md](RELEASING.md) for the steps.
93
-
94
90
## Licensing
95
91
96
92
Code contributions are licensed under the [Apache License 2.0](LICENSE). Documentation contributions are licensed under [Creative Commons Attribution 4.0 International (CC-BY-4.0)](https://creativecommons.org/licenses/by/4.0/). See the LICENSE file and the [technical charter](sqlmesh-technical-charter.pdf) for details.
93
+
94
+
## Releases
95
+
96
+
Maintainers publish releases. See [RELEASING.md](RELEASING.md) for the steps.
Copy file name to clipboardExpand all lines: RELEASING.md
+8-10Lines changed: 8 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,9 +17,9 @@ The workflow does four things:
17
17
1. Builds the web UI and bundles it into the package.
18
18
2. Publishes `sqlmesh` to PyPI with `make publish`.
19
19
3. Publishes the test package to the private `tobiko-private` registry with `make publish-tests`.
20
-
4. Creates a GitHub release with notes generated from the pull requests merged since the previous tag.
20
+
4. Creates a draft GitHub release with notes generated from the pull requests merged since the previous tag.
21
21
22
-
Each step publishes immediately and there's no approval gate. Check `main` before you tag.
22
+
The PyPI and private registry uploads happen immediately, with no approval gate. Check `main` before you tag.
23
23
24
24
### Steps
25
25
@@ -37,21 +37,19 @@ Each step publishes immediately and there's no approval gate. Check `main` befor
37
37
38
38
4. Watch the [Release](https://github.com/SQLMesh/sqlmesh/actions/workflows/release.yaml) run until it finishes.
39
39
5. Check that the new version is on [PyPI](https://pypi.org/project/sqlmesh/#history).
40
-
6. Edit the generated GitHub release. Under **Breaking changes**, add a short upgrade note foreach entry. Say what users will see after upgrading, such as a migration or a metadata-only changein`sqlmesh plan`.
40
+
6. Open the draft release on the [Releases page](https://github.com/SQLMesh/sqlmesh/releases). Under **Breaking changes**, add a short upgrade note foreach entry. Say what users will see after upgrading, such as a migration or a metadata-only changein`sqlmesh plan`. Then publish it. Until you do, no GitHub release appears for the version, even though it's on PyPI.
41
41
42
42
If the workflow fails after the PyPI step, don't delete or reuse the tag. PyPI doesn't accept the same version twice. Fix the cause and release the next version.
43
43
44
44
### Release Notes
45
45
46
-
GitHub builds the notes from merged pull request titles and groups them by label, as configured in [`.github/release.yml`](.github/release.yml):
46
+
GitHub builds the notes from merged pull request titles and groups them by label, as configured in [`.github/release.yml`](.github/release.yml). The [PR Labels](.github/workflows/pr-labels.yaml) workflow applies the labels from each pull request's title (`type(scope): description`) and the files it changes. See [Pull Request Titles](CONTRIBUTING.md#pull-request-titles) in`CONTRIBUTING.md`.
47
47
48
-
| Label | Section |
49
-
|---|---|
50
-
|`breaking-change`| Breaking changes |
51
-
|`dependencies`| Dependencies |
52
-
| Any other label, or none | Other changes |
48
+
- A `!`in the title, such as `fix!:` or `feat!:`, puts the pull request under **Breaking changes**.
49
+
- A pull request that adds a state migration goes under **State migrations**.
50
+
- CI, test and Dependabot pull requests are left out. Add the `skip-changelog` label to leave out any other pull request.
53
51
54
-
Dependabot adds `dependencies` automatically. Add `breaking-change` by hand to any pull request whose title has a `!`, such as `fix!:` or `feat!:`, before it merges. Without the label, the change appears under **Other changes**.
52
+
To move a pull request to another section, change its title. The workflow resets the type labels from the title.
0 commit comments