mirror of
https://github.com/apache/superset.git
synced 2026-04-19 16:14:52 +00:00
chore: Splits the CHANGELOG into multiple files (#26800)
This commit is contained in:
committed by
GitHub
parent
8657fa753b
commit
23460b21f6
@@ -24,22 +24,10 @@ you'll probably want to run these commands manually and understand what
|
||||
they do prior to doing so.
|
||||
|
||||
For coordinating on releases, on operational topics that require more
|
||||
synchronous communications, we recommend using the `#apache-releases` channel
|
||||
synchronous communications, we recommend using the release channel
|
||||
on the Superset Slack. People crafting releases and those interested in
|
||||
partaking in the process should join the channel.
|
||||
|
||||
## Release notes for recent releases
|
||||
|
||||
- [3.1](release-notes-3-1/README.md)
|
||||
- [2.0](release-notes-2-0/README.md)
|
||||
- [1.5](release-notes-1-5/README.md)
|
||||
- [1.4](release-notes-1-4/README.md)
|
||||
- [1.3](release-notes-1-3/README.md)
|
||||
- [1.2](release-notes-1-2/README.md)
|
||||
- [1.1](release-notes-1-1/README.md)
|
||||
- [1.0](release-notes-1-0/README.md)
|
||||
- [0.38](release-notes-0-38/README.md)
|
||||
|
||||
## Release setup (First Time Only)
|
||||
|
||||
First you need to setup a few things. This is a one-off and doesn't
|
||||
@@ -231,7 +219,7 @@ git push
|
||||
|
||||
### Updating changelog
|
||||
|
||||
Next, update the `CHANGELOG.md` with all the changes that are included in the release.
|
||||
Next, update the `CHANGELOG/<version>.md` with all the changes that are included in the release.
|
||||
Make sure the branch has been pushed to `origin` to ensure the changelog generator
|
||||
can pick up changes since the previous release.
|
||||
Similar to `cherrytree`, the change log script requires a github token, either as an env var
|
||||
@@ -255,7 +243,7 @@ python changelog.py --previous_version 0.37 --current_version 0.38 changelog --a
|
||||
```
|
||||
|
||||
The script will checkout both branches, compare all the PRs, and output the lines that are needed to be added to the
|
||||
`CHANGELOG.md` file in the root of the repo. Remember to also make sure to update the branch id (with the above command
|
||||
`CHANGELOG/<version>.md` file in the root of the repo. Remember to also make sure to update the branch id (with the above command
|
||||
`1.5` needs to be changed to `1.5.0`)
|
||||
|
||||
Then, in `UPDATING.md`, a file that contains a list of notifications around
|
||||
@@ -394,16 +382,17 @@ https://www.apache.org/info/verification.html
|
||||
We now have a handy script for anyone validating a release to use. The core of it is in this very folder, `verify_release.py`. Just make sure you have all three release files in the same directory (`{some version}.tar.gz`, `{some version}.tar.gz.asc` and `{some version}tar.gz.sha512`). Then you can pass this script the path to the `.gz` file like so:
|
||||
`python verify_release.py ~/path/tp/apache-superset-{version/candidate}-source.tar.gz`
|
||||
|
||||
|
||||
If all goes well, you will see this result in your terminal:
|
||||
|
||||
```bash
|
||||
SHA-512 verified
|
||||
RSA key verified
|
||||
```
|
||||
|
||||
There are also additional support scripts leveraging this to make it easy for those downloading a release to test it in-situ. You can do either of the following to validate these release assets:
|
||||
* `cd` into `superset-frontend` and run `npm run validate-release`
|
||||
* `cd` into `RELEASES` and run `./validate_this_release.sh`
|
||||
|
||||
- `cd` into `superset-frontend` and run `npm run validate-release`
|
||||
- `cd` into `RELEASES` and run `./validate_this_release.sh`
|
||||
|
||||
## Publishing a successful release
|
||||
|
||||
@@ -500,6 +489,6 @@ At this point, a GitHub action will run that will check whether this release's v
|
||||
|
||||
### Update Superset files
|
||||
|
||||
Now that we have a final Apache release we need to open a pull request on Superset with the changes on [CHANGELOG.m](../CHANGELOG.md) and [UPDATING.md](../UPDATING.md).
|
||||
Now that we have a final Apache release we need to open a pull request on Superset with the changes on [CHANGELOG/\<version\>.md](../CHANGELOG) and [UPDATING.md](../UPDATING.md).
|
||||
|
||||
We also need to update the Environment section of [ISSUE_TEMPLATE/bug-report.yml](../.github/ISSUE_TEMPLATE//bug-report.yml) to reflect the new release changes. This includes removing versions that are not supported anymore and adding new ones.
|
||||
|
||||
@@ -28,17 +28,15 @@ The Apache {{ project_name }} team is pleased to announce that {{ project_name }
|
||||
{{ project_description }}
|
||||
|
||||
The official source release:
|
||||
|
||||
https://www.apache.org/dist/{{ project_module }}/{{ version }}
|
||||
https://downloads.apache.org/{{ project_module }}/{{ version }}
|
||||
|
||||
The PyPI package:
|
||||
|
||||
https://pypi.org/project/apache-superset/
|
||||
https://pypi.org/project/apache-superset/{{ version }}
|
||||
|
||||
The Change Log for the release:
|
||||
https://github.com/apache/{{ project_module }}/blob/{{ version }}/CHANGELOG.md
|
||||
https://github.com/apache/{{ project_module }}/blob/{{ version }}/CHANGELOG/{{ version }}.md
|
||||
|
||||
The Updating instructions for the release:
|
||||
The instructions for updating to the release:
|
||||
https://github.com/apache/{{ project_module }}/blob/{{ version }}/UPDATING.md
|
||||
|
||||
If you have any usage questions or have problems when upgrading or
|
||||
|
||||
@@ -20,7 +20,7 @@ To: {{ receiver_email }}
|
||||
|
||||
Subject: [RESULT] [VOTE] Release Apache {{ project_name }} {{ version }} based on Superset {{ version_rc }}
|
||||
|
||||
Thanks to everyone that participated. The vote to release
|
||||
Thanks to everyone who participated. The vote to release
|
||||
Apache {{ project_name }} version {{ version }} based on {{ version_rc }} is now closed.
|
||||
|
||||
{% if vote_negatives|length > 0 -%}
|
||||
@@ -28,7 +28,7 @@ The vote did NOT PASS with {{vote_bindings|length}} binding +1, {{ vote_nonbindi
|
||||
{% elif vote_bindings|length > 2 -%}
|
||||
The vote PASSED with {{vote_bindings|length}} binding +1, {{ vote_nonbindings|length}} non-binding +1, and {{vote_negatives|length}} -1 votes:
|
||||
{% else -%}
|
||||
The vote is non conclusive with {{vote_bindings|length}} binding +1, {{ vote_nonbindings|length}} non-binding -1, and {{vote_negatives|length}} -1 votes:
|
||||
The vote is non conclusive with {{vote_bindings|length}} binding +1, {{ vote_nonbindings|length}} non-binding +1, and {{vote_negatives|length}} -1 votes:
|
||||
{%- endif %}
|
||||
|
||||
{% if vote_bindings|length > 0 -%}
|
||||
|
||||
@@ -27,13 +27,13 @@ This is a call for the vote to release Apache {{ project_name }} version {{ vers
|
||||
The release candidate:
|
||||
https://dist.apache.org/repos/dist/dev/{{ project_module }}/{{ version_rc }}/
|
||||
|
||||
Git tag for the release:
|
||||
The Git tag for the release:
|
||||
https://github.com/apache/{{ project_module }}/tree/{{ version_rc }}
|
||||
|
||||
The Change Log for the release:
|
||||
https://github.com/apache/{{ project_module }}/blob/{{ version_rc }}/CHANGELOG.md
|
||||
The change log for the release:
|
||||
https://github.com/apache/{{ project_module }}/blob/{{ version_rc }}/CHANGELOG/{{ version }}.md
|
||||
|
||||
The Updating instructions for the release:
|
||||
The instructions for updating to the release:
|
||||
https://github.com/apache/{{ project_module }}/blob/{{ version_rc }}/UPDATING.md
|
||||
|
||||
Public keys are available at:
|
||||
|
||||
@@ -49,7 +49,7 @@ Superset 1.4 focuses heavily on continuing to polish the core Superset experienc
|
||||
|
||||
- Databricks: Superset now supports the new [SQL Endpoints in Databricks](https://docs.databricks.com/sql/admin/sql-endpoints.html). ([#16862](https://github.com/apache/superset/pull/16862))
|
||||
|
||||
- Apache Druid: Superset Explore now can take advantage of support for JOIN's in Druid (note: the `DRUID_JOINS` feature flag needs to be enabled). ([#16770](https://github.com/apache/superset/pull/16770))
|
||||
- Apache Druid: Superset Explore now can take advantage of support for JOIN's in Druid (note: the `DRUID_JOINS` feature flag needs to be enabled). ([#16770](https://github.com/apache/superset/pull/16770))
|
||||
|
||||
- AWS Aurora: Superset now has a separate db_engine_spec for Amazon Aurora. ([#16535](https://github.com/apache/superset/pull/16535))
|
||||
|
||||
@@ -57,7 +57,6 @@ Superset 1.4 focuses heavily on continuing to polish the core Superset experienc
|
||||
|
||||
- Google Sheets: Better support for private Google Sheets was added. ([#16228](https://github.com/apache/superset/pull/16628))
|
||||
|
||||
|
||||
## Developer Experience
|
||||
|
||||
- The `Makefile` for Superset has gone through a number of improvements. ([#16327](https://github.com/apache/superset/pull/16327), [#16533](https://github.com/apache/superset/pull/16533))
|
||||
@@ -75,4 +74,4 @@ Superset 1.4 focuses heavily on continuing to polish the core Superset experienc
|
||||
|
||||
**Changelog**
|
||||
|
||||
To see the complete changelog in this release, head to [CHANGELOG.MD](https://github.com/apache/superset/blob/master/CHANGELOG.md). As mentioned earlier, this release has a MASSIVE amount of bug fixes. The full changelog lists all of them!
|
||||
To see the complete changelog in this release, head to [CHANGELOG.MD](https://github.com/apache/superset/blob/master/CHANGELOG/1.4.1.md). As mentioned earlier, this release has a MASSIVE amount of bug fixes. The full changelog lists all of them!
|
||||
|
||||
@@ -137,6 +137,6 @@ when available.
|
||||
**Changelog**
|
||||
|
||||
To see the complete changelog in this release, head to
|
||||
[CHANGELOG.MD](https://github.com/apache/superset/blob/1.5/CHANGELOG.md).
|
||||
[CHANGELOG.MD](https://github.com/apache/superset/blob/1.5/CHANGELOG/1.5.0.md).
|
||||
As mentioned earlier, this release has a MASSIVE amount of bug fixes. The full
|
||||
changelog lists all of them!
|
||||
|
||||
Reference in New Issue
Block a user