QT/superset2
1
0
Fork 0
mirror of https://github.com/apache/superset.git synced 2026-04-19 08:04:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(release): small fixes and deprecate apache docs (#11827)

Browse Source 
* docs(release): small fixes and deprecate apache docs

* remove last 0.38 reference
This commit is contained in:
Daniel Vaz Gaspar
2020-11-26 11:49:59 +00:00
committed by GitHub
parent 1591d75d2f
commit 35784106dd
4 changed files with 12 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
RELEASING/README.md
View File

@@ -77,23 +77,23 @@ Usage (ZSH):
Example:
```bash
source set_release_env.sh 0.37.0rc1 myid@apache.org
source set_release_env.sh 0.38.0rc1 myid@apache.org
```
The script will output the exported variables. Here's example for 0.37.0rc1:
The script will output the exported variables. Here's example for 0.38.0rc1:
```
Set Release env variables
SUPERSET_VERSION=0.37.0
SUPERSET_VERSION=0.38.0
SUPERSET_RC=1
SUPERSET_GITHUB_BRANCH=0.37
SUPERSET_GITHUB_BRANCH=0.38
SUPERSET_PGP_FULLNAME=myid@apache.org
SUPERSET_VERSION_RC=0.37.0rc1
SUPERSET_RELEASE=apache-superset-incubating-0.37.0
SUPERSET_RELEASE_RC=apache-superset-incubating-0.37.0rc1
SUPERSET_RELEASE_TARBALL=apache-superset-incubating-0.37.0-source.tar.gz
SUPERSET_RELEASE_RC_TARBALL=apache-superset-incubating-0.37.0rc1-source.tar.gz
SUPERSET_TMP_ASF_SITE_PATH=/tmp/incubator-superset-site-0.37.0
SUPERSET_VERSION_RC=0.38.0rc1
SUPERSET_RELEASE=apache-superset-incubating-0.38.0
SUPERSET_RELEASE_RC=apache-superset-incubating-0.38.0rc1
SUPERSET_RELEASE_TARBALL=apache-superset-incubating-0.38.0-source.tar.gz
SUPERSET_RELEASE_RC_TARBALL=apache-superset-incubating-0.38.0rc1-source.tar.gz
SUPERSET_TMP_ASF_SITE_PATH=/tmp/incubator-superset-site-0.38.0
```
## Crafting a source release
@@ -130,7 +130,7 @@ section for the new release.
Finally bump the version number on `superset-frontend/package.json` (replace with whichever version is being released excluding the RC version):
```json
"version": "0.36.0"
"version": "0.38.0"
```
Commit the change with the version number, then git tag the version with the release candidate and push to the branch:
@@ -329,23 +329,3 @@ Finally, so the Github UI reflects the latest release, you should create a relea
tag corresponding with the new version. Go to https://github.com/apache/incubator-superset/tags,
click the 3-dot icon and select `Create Release`, paste the content of the ANNOUNCE thread in the
release notes, and publish the new release.
## Post release
#### Refresh documentation website
Every once in a while we want to compile the documentation and publish it.
Here's how to do it.
```bash
./make_docs.sh
```
Superset documentation site is ready at http://localhost:5002
```
$ cd /tmp/incubator-superset-site-${SUPERSET_VERSION}
$ git add .
$ git commit -a -m "New doc version ${SUPERSET_VERSION}"
$ git push origin asf-site
```

55
RELEASING/make_docs.sh
View File

@@ -1,55 +0,0 @@
#!/bin/bash
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
set -e
DOCKER_TMP_ASF_SITE_PATH=/asf-site
DOC_SITE_PORT=5002
# Clean tmp dir
if [[ -d "${SUPERSET_TMP_ASF_SITE_PATH}" ]]; then
rm -rf "${SUPERSET_TMP_ASF_SITE_PATH}"
fi
mkdir -p "${SUPERSET_TMP_ASF_SITE_PATH}"
# Building docker that will help update superset asf-site
docker build --no-cache -t apache-docs \
--build-arg VERSION="${SUPERSET_VERSION}" \
-f Dockerfile.make_docs .
# Running docker to update superset asf-site
docker run \
-v "${SUPERSET_TMP_ASF_SITE_PATH}":"${DOCKER_TMP_ASF_SITE_PATH}":rw \
-e HOST_UID=${UID} \
-p ${DOC_SITE_PORT}:8000 \
-d \
-ti apache-docs
RESULT=$?
if [ $RESULT -ne 0 ]; then
echo Updating and launching documentation site failed
echo tip: Check if other container is using port:$DOC_SITE_PORT
exit 1
fi
echo "---------------------------------------------------"
echo Superset documentation site is ready at http://localhost:5002
echo Check it out and if all looks good:
echo $ cd "${SUPERSET_TMP_ASF_SITE_PATH}"
echo $ git add .
echo $ git commit -a -m \"New doc version "${SUPERSET_VERSION}"\"
echo $ git push origin asf-site

26
RELEASING/make_docs_entrypoint.sh
View File

@@ -1,26 +0,0 @@
#!/bin/bash
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
set -e
git clone --branch asf-site https://git-wip-us.apache.org/repos/asf/incubator-superset-site.git /asf-site
# copy html files to temp folder
cp -rv /superset/docs/_build/html/* /asf-site
chown -R ${HOST_UID}:${HOST_UID} /asf-site
cd /asf-site
python -m http.server

2
UPDATING.md
View File

@@ -51,7 +51,7 @@ assists people when migrating to a new version.
* [10887](https://github.com/apache/incubator-superset/pull/10887): Breaking change: The custom cache backend changed in order to support the Flask-Caching factory method approach and thus must be registered as a custom type. See [here](https://flask-caching.readthedocs.io/en/latest/#custom-cache-backends) for specifics.
* [10674](https://github.com/apache/incubator-superset/pull/10674): Breaking change: PUBLIC_ROLE_LIKE_GAMMA was removed is favour of the new PUBLIC_ROLE_LIKE so it can be set it whatever role you want.
* [10674](https://github.com/apache/incubator-superset/pull/10674): Breaking change: PUBLIC_ROLE_LIKE_GAMMA was removed is favour of the new PUBLIC_ROLE_LIKE so it can be set to whatever role you want.
* [10590](https://github.com/apache/incubator-superset/pull/10590): Breaking change: this PR will convert iframe chart into dashboard markdown component, and remove all `iframe`, `separator`, and `markup` slices (and support) from Superset. If you have important data in those slices, please backup manually.