未验证 提交 53757451 编写于 作者: M Maxime Beauchemin 提交者: GitHub

Improve release instructions (#8016)

上级 f039e17c
...@@ -16,57 +16,6 @@ KIND, either express or implied. See the License for the ...@@ -16,57 +16,6 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations specific language governing permissions and limitations
under the License. under the License.
--> -->
# Apache Releases
To make a fresh tarball of a git reference on apache/incubator-superset
(push your tag first!)
```bash
docker build -t make_tarball -f Dockerfile.make_tarball . --build-arg VERSION=0.33.0rc1
docker run make_tarball -f Dockerfile.make_tarball --env VERSION=0.33.0rc1
```
To make a working build given a tarball
```bash
# Building a docker from a tarball
VERSION=0.33.0rc2 && \
docker build -t apache-superset:$VERSION -f Dockerfile.from_tarball . --build-arg VERSION=$VERSION
# testing the resulting docker
docker run -p 5001:8088 apache-superset:0.33.0rc2
# you should be able to access localhost:5001 on your browser
# login using admin/admin
```
## Refresh documentation website
Every once in a while we want to compile the documentation and publish it.
Here's how to do it.
```bash
# install doc dependencies
pip install -r docs/requirements.txt
# build the docs
python setup.py build_sphinx
# copy html files to temp folder
cp -r docs/_build/html/ /tmp/tmp_superset_docs/
# clone the docs repo
cd ~/
git clone https://git-wip-us.apache.org/repos/asf/incubator-superset-site.git
# copy
cp -r /tmp/tmp_superset_docs/ ~/incubator-superset-site.git/
# commit and push to `asf-site` branch
cd ~/incubator-superset-site.git/
git checkout asf-site
git add .
git commit -a -m "New doc version"
git push origin master
```
# Apache Releases # Apache Releases
...@@ -81,20 +30,20 @@ need to be done at every release. ...@@ -81,20 +30,20 @@ need to be done at every release.
```bash ```bash
# Create PGP Key, and use your @apache.org email address # Create PGP Key, and use your @apache.org email address
gpg --gen-key gpg --gen-key
# Checkout ASF dist repo # Checkout ASF dist repo
svn checkout https://dist.apache.org/repos/dist/dev/incubator/superset/ ~/svn/superset_dev svn checkout https://dist.apache.org/repos/dist/dev/incubator/superset/ ~/svn/superset_dev
svn checkout https://dist.apache.org/repos/dist/release/incubator/superset/ ~/svn/superset svn checkout https://dist.apache.org/repos/dist/release/incubator/superset/ ~/svn/superset
cd ~/svn/superset cd ~/svn/superset
# Add your GPG pub key to KEYS file. Replace "Maxime Beauchemin" with your name # Add your GPG pub key to KEYS file. Replace "Maxime Beauchemin" with your name
export FULLNAME="Maxime Beauchemin" export FULLNAME="Maxime Beauchemin"
(gpg --list-sigs $FULLNAME && gpg --armor --export $FULLNAME ) >> KEYS (gpg --list-sigs $FULLNAME && gpg --armor --export $FULLNAME ) >> KEYS
# Commit the changes # Commit the changes
svn commit -m "Add PGP keys of new Superset committer" svn commit -m "Add PGP keys of new Superset committer"
``` ```
...@@ -107,7 +56,7 @@ Now let's craft a source release ...@@ -107,7 +56,7 @@ Now let's craft a source release
# Setting a VERSION var will be useful # Setting a VERSION var will be useful
export VERSION=0.31.0rc18 export VERSION=0.31.0rc18
export RELEASE=apache-superset-incubating-${VERSION} export RELEASE=apache-superset-incubating-${VERSION}
export RELEASE_TARBAL=${RELEASE}-source.tar.gz export RELEASE_TARBALL=${RELEASE}-source.tar.gz
# Let's create a git tag # Let's create a git tag
git tag -f ${VERSION} git tag -f ${VERSION}
...@@ -122,10 +71,10 @@ Now let's craft a source release ...@@ -122,10 +71,10 @@ Now let's craft a source release
mkdir -p ~/svn/superset_dev/${VERSION}/ mkdir -p ~/svn/superset_dev/${VERSION}/
git archive \ git archive \
--format=tar.gz ${VERSION} \ --format=tar.gz ${VERSION} \
--prefix=${RELEASE}/ \ --prefix="${RELEASE}/" \
-o ~/svn/superset_dev/${VERSION}/${RELEASE_TARBALL} -o ~/svn/superset_dev/${VERSION}/${RELEASE_TARBALL}
cd ~/svn/superset_dev/ cd ~/svn/superset_dev/${VERSION}/
scripts/sign.sh ${RELEASE}-source.tar.gz scripts/sign.sh ${RELEASE}-source.tar.gz
``` ```
...@@ -134,9 +83,6 @@ Now let's craft a source release ...@@ -134,9 +83,6 @@ Now let's craft a source release
Now let's ship this RC into svn's dev folder Now let's ship this RC into svn's dev folder
```bash ```bash
# cp or mv the files over to the svn repo
mkdir ~/svn/superset_dev/${VERSION}/
cp ${RELEASE_TARBALL} ~/svn/superset_dev/${VERSION}/
cd ~/svn/superset_dev/ cd ~/svn/superset_dev/
svn add ${VERSION} svn add ${VERSION}
svn commit svn commit
...@@ -161,3 +107,47 @@ folder. ...@@ -161,3 +107,47 @@ folder.
Now you can announce the release on the mailing list, make sure to use the Now you can announce the release on the mailing list, make sure to use the
proper template proper template
## Build from source tarball
To make a working build given a tarball
```bash
# Building a docker from a tarball
VERSION=0.33.0rc2 && \
docker build -t apache-superset:$VERSION -f Dockerfile.from_tarball . --build-arg VERSION=$VERSION
# testing the resulting docker
docker run -p 5001:8088 apache-superset:$VERSION
# you should be able to access localhost:5001 on your browser
# login using admin/admin
```
# Refresh documentation website
Every once in a while we want to compile the documentation and publish it.
Here's how to do it.
```bash
# install doc dependencies
pip install -r docs/requirements.txt
# build the docs
python setup.py build_sphinx
# copy html files to temp folder
cp -r docs/_build/html/ /tmp/tmp_superset_docs/
# clone the docs repo
cd ~/
git clone https://git-wip-us.apache.org/repos/asf/incubator-superset-site.git
# copy
cp -r /tmp/tmp_superset_docs/ ~/incubator-superset-site.git/
# commit and push to `asf-site` branch
cd ~/incubator-superset-site.git/
git checkout asf-site
git add .
git commit -a -m "New doc version"
git push origin master
```
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册