-
Notifications
You must be signed in to change notification settings - Fork 54
3.16.0rc0
-
1: Clone repository in a fresh directory
pushd "$(mktemp -d)" git clone git@github.com:CCSI-Toolset/FOQUS.git && cd FOQUS
-
2: Switch to release branch if it exists, else create it
git checkout "3.16_rel" || git checkout -b "3.16_rel"
-
3: Review differences with the default branch
- Go to compare URL https://github.com/CCSI-Toolset/FOQUS/compare/3.16_rel...master
-
4: Cherry-pick commits onto the release branch(N/A) -
5: Update version and dependencies in(N/A)./setup.py
(WaterTAP, DISPATCHES) -
6: Update version and dependencies (FOQUS)
- Open
./setup.py
- Search for
default_version =
and setdefault_version = "3.16.0rc0"
- Save and exit
- Open
./docs/source/conf.py
- Search for
version =
and setversion = "3.16.0rc0"
- Search for
release =
and setrelease = "3.16.0rc0"
- Save and exit
-
git add setup.py ./docs/source/conf.py
- Open
-
7: Update version (IDAES)(N/A) -
8: Update version (IDAES examples)(N/A) -
9: Update version and dependencies in(N/A)./setup.py
(PARETO) -
10: Check that the local modifications to the version are as they should
git status # there shouldn't be any other unstaged files git status -vv # the changes with the version should be there
-
11: Commit the changes to the
3.16_rel
branch# check that we're on the correct release branch test "$(git branch --show-current)" = "3.16_rel" && git commit -m "3.16.0rc0"
-
12: Review the changes before pushing
git log --oneline -n 5 # it should show only one commit which is not pushed git push --set-upstream git@github.com:CCSI-Toolset/FOQUS.git "3.16_rel" --dry-run
-
13: Push the changes
git push --set-upstream git@github.com:CCSI-Toolset/FOQUS.git "3.16_rel"
-
1: Clone repository in a fresh directory
pushd "$(mktemp -d)" git clone git@github.com:CCSI-Toolset/FOQUS.git && cd FOQUS
-
2: Update version and dependencies in
./setup.py
(FOQUS)- Open
./setup.py
- Search for
default_version =
and setdefault_version = "3.17.dev0"
- Save and exit
- Open
-
3: Update version (IDAES)(N/A) -
4: Update version (IDAES examples)(N/A) -
5: Update version in
./docs/source/conf.py
- Open
./docs/source/conf.py
- Search for
version =
and setversion = "3.17.dev0"
- Search for
release =
and setrelease = "3.17.dev0"
- Save and exit
- Open
-
6: Update version and dependencies in(N/A)./setup.py
(PARETO) -
7: Update version and dependencies in(N/A)./setup.py
anddocs/conf.py
(WaterTAP, DISPATCHES) -
8: Check that the local modifications to the version are as they should
git status # there shouldn't be any other unstaged files git status -vv # the changes with the version should be there
-
9: Commit the changes to the default branch
# check that we're on the default branch test "$(git branch --show-current)" = "master" && git commit -m "3.17.dev0"
-
10: Review the changes before pushing
git log --oneline -n 5 # it should show only one commit which is not pushed git push --dry-run
-
11: Push the changes
git push
-
1: Generate release notes and create GitHub draft release Copy and paste the following release notes into a file named
release-notes-3.16.0rc0.md
:# Release Candidate #0 Start with our [online documentation](https://foqus.readthedocs.org/en/3.16.0rc0) to get started with install instructions, examples, etc. Note: Download the below `ccsi-foqus-3.16.0rc0-examples.zip` file for all the CCSI-FOQUS examples, tutorials and test files. ## 3.16.0rc0 Release Highlights:
Or, run the following shell command to create the file in the local directory:
cat <<'EOF' > release-notes-3.16.0rc0.md # Release Candidate #0 Start with our [online documentation](https://foqus.readthedocs.org/en/3.16.0rc0) to get started with install instructions, examples, etc. Note: Download the below `ccsi-foqus-3.16.0rc0-examples.zip` file for all the CCSI-FOQUS examples, tutorials and test files. ## 3.16.0rc0 Release Highlights: EOF
Run this command to create a draft release using the
gh
CLI toolgh release create "3.16.0rc0" --repo "CCSI-Toolset/FOQUS" --target "3.16_rel" --title "Release Candidate #0" --notes-file "release-notes-3.16.0rc0.md" --prerelease --draft
-
2: Create a ZIP file for the examples and attach it to the release as an asset
_asset_file_name="ccsi-foqus-3.16.0rc0-examples.zip" zip -r "$_asset_file_name" examples/ gh release upload "3.16.0rc0" "$_asset_file_name" --repo "CCSI-Toolset/FOQUS"
-
3: Update the compatibility file on(N/A)main
-
4: Check that the GitHub release was created successfully
- Go to https://github.com/CCSI-Toolset/FOQUS/releases/tag/3.16.0rc0
- If "Draft", click on https://github.com/CCSI-Toolset/FOQUS/releases/edit/3.16.0rc0 to remove the "Draft" marker
-
5: Check that the release tag has been created in the repo
curl -sL https://github.com/CCSI-Toolset/FOQUS/archive/3.16.0rc0.zip | sha256sum
NOTE
- The release needs to be undrafted for this to work
- Use
wget
ifcurl -sL
doesn't work
-
1: Delete the release on GitHub
# add the --yes flag to skip confirmation prompt gh release delete --repo CCSI-Toolset/FOQUS "3.16.0rc0"
-
2: Delete the tag on the remote
pushd "$(mktemp -d)" git clone --depth 1 --branch "3.16_rel" https://github.com/CCSI-Toolset/FOQUS && cd FOQUS git push --delete git@github.com:CCSI-Toolset/FOQUS.git "refs/tags/3.16.0rc0"
-
3: Delete the tag locally
git tag --delete "3.16.0rc0"
-
1: Check the ReadTheDocs build
- Go to https://www.readthedocs.org/projects/foqus/builds and check that the build for
3.16.0rc0
has been run successfully - If not, edit the version at https://www.readthedocs.org/dashboard/foqus/version/3.16.0rc0/edit so that it starts building
- If the previous step didn't work, go to https://www.readthedocs.org/projects/foqus/versions, search for the
3.16.0rc0
version, and click on "Edit"
- Go to https://www.readthedocs.org/projects/foqus/builds and check that the build for
-
2: Check that the
3.16.0rc0
tag is available on ReadTheDocs- Manually, at https://foqus.readthedocs.org/en/3.16.0rc0
-
curl -sL "https://foqus.readthedocs.org/en/3.16.0rc0" | grep "/3.16.0rc0/"
-
curl -sL "https://foqus.readthedocs.org/en/3.16.0rc0" | grep "Versions" --after 10 | grep "/3.16.0rc0/"
-
3: Check that the ReadTheDocs revision (commit) on
latest
matches the release tagcurl -sL "https://foqus.readthedocs.org/en/3.16.0rc0" | grep "Revision" curl -sL "https://foqus.readthedocs.org/en/latest" | grep "Revision" curl -sL "https://foqus.readthedocs.org" | grep "Revision"
-
4: Check that the ReadTheDocs revision (commit) on(N/A)stable
matches the release tag
-
1: In a clean directory, clone the repo and switch to the release branch
pushd "$(mktemp -d)" git clone --depth 1 --branch "3.16_rel" https://github.com/CCSI-Toolset/FOQUS && cd FOQUS # check that the branch is at the 3.16.0rc0 tag git tag --list | grep "3.16.0rc0"
-
2: Create a new Conda environment for building the package and activate it
# bash/zsh _build_env_name="build-ccsi-foqus-3.16.0rc0" conda create --yes python=3.8 pip setuptools wheel twine --name "$_build_env_name" && conda activate "$_build_env_name" # test that the pip executable is the one from the environment which pip | grep "$_build_env_name"
-
3: Install the package (NO EDITABLE MODE)
pip install --no-cache-dir .
-
4: Check that the installed package has the proper tags
pip list | grep "3.16.0rc0" pip show ccsi-foqus | grep "3.16.0rc0"
-
5: Run "smoke tests" for the installed package (once uploaded to PyPI, IT CANNOT BE DELETED!)
foqus -w "$(mktemp -d)"
-
6: Remove large directories to avoid exceeding size limits
rm -r ./examples/
-
7: Build the
sdist
andbdist_wheel
distributionspython setup.py sdist bdist_wheel
-
8: Check that the directory size is below PyPI's maximum
ls -lh dist/* _maxsize=100000 # 100 MB _dirsize=$(du -s dist/ | cut -f 1) ; echo $_dirsize [ "$_dirsize" -lt "$_maxsize" ]
-
9: Upload the distributions to the test PyPI
# bash/zsh # assumes that the ~/.pypirc config file exists and defines the "testpypi" repository grep "\[testpypi\]" ~/.pypirc && twine upload --repository testpypi dist/*
NOTE It might take a while for the uploaded package to become available for
pip install
-
10: Test package from test PyPI in a dedicated temp Conda environment
_test_env_name="test-ccsi-foqus-3.16.0rc0" conda create --yes python=3.8 --name "$_test_env_name" && conda activate "$_test_env_name" which pip | grep "$_test_env_name" pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple "ccsi-foqus==3.16.0rc0" foqus -w "$(mktemp -d)" conda deactivate && conda env remove --name "$_test_env_name"
-
11: Upload the distributions to the real PyPI
conda activate "$_build_env_name" # assumes that the ~/.pypirc config file exists and defines the "realpypi" repository grep "\[realpypi\]" ~/.pypirc && twine upload --repository realpypi dist/*
NOTE It might take a while for the uploaded package to become available for
pip install
-
12: Install package from real PyPI and generate requirements/environment files
# bash/zsh _rel_prefix="ccsi-foqus-3.16.0rc0" _env_name="${_rel_prefix}-env" _conda_file_name="environment-${_rel_prefix}.yml" _pip_file_name="requirements-${_rel_prefix}.txt" conda create --yes python=3.8 --name "$_env_name" && conda activate "$_env_name" which pip | grep "$_env_name" pip install "ccsi-foqus==3.16.0rc0" pushd "$(mktemp -d)" conda env export -n "$_env_name" -f "$_conda_file_name" pip freeze > "$_pip_file_name" gh release upload "3.16.0rc0" "$_conda_file_name" "$_pip_file_name" --repo "CCSI-Toolset/FOQUS" conda deactivate && popd