diff --git a/README.md b/README.md index 2c3f625..1a0cea9 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@

- +

# BayesO Benchmarks: Benchmark Functions for Bayesian Optimization -[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7577331.svg)](https://doi.org/10.5281/zenodo.7577331) +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7577330.svg)](https://doi.org/10.5281/zenodo.7577330) [![Build Status](https://github.com/jungtaekkim/bayeso-benchmarks/actions/workflows/pytest.yml/badge.svg)](https://github.com/jungtaekkim/bayeso-benchmarks/actions/workflows/pytest.yml) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) @@ -76,9 +76,9 @@ Y_noise = obj_fun.output_gaussian_noise(X) @misc{KimJ2023software, author={Kim, Jungtaek}, title={{BayesO Benchmarks}: Benchmark Functions for {Bayesian} Optimization}, - doi={10.5281/zenodo.7577331}, + doi={10.5281/zenodo.7577330}, url={https://github.com/jungtaekkim/bayeso-benchmarks}, - howpublished={\url{https://doi.org/10.5281/zenodo.7577331}}, + howpublished={\url{https://doi.org/10.5281/zenodo.7577330}}, year={2023} } ``` diff --git a/create_wheels_source.txt b/create_wheels_source.txt deleted file mode 100644 index 8f5ef1c..0000000 --- a/create_wheels_source.txt +++ /dev/null @@ -1,13 +0,0 @@ -# Merge a working branch to a main branch first. -# -# Install setuptools wheel first, then command it. -python2 setup.py sdist bdist_wheel # It is deprecated. -python3 setup.py sdist bdist_wheel - -# Install twine. -twine upload dist/* - -## (Optional) Upload to Anaconda repository. -~/anaconda3/bin/anaconda upload dist/*.tar.gz -# or, just -anaconda upload dist/*.tar.gz diff --git a/publish_new_release.txt b/publish_new_release.txt new file mode 100644 index 0000000..a5bd272 --- /dev/null +++ b/publish_new_release.txt @@ -0,0 +1,29 @@ +# 1. Merge a working branch to the main branch first. + +# 2. Clone the main branch in a new clean directory. + +# 3. (If needed) Install setuptools and wheel. + +# 4. Create wheel and source files. +python2 setup.py sdist bdist_wheel (deprecated) +python3 setup.py sdist bdist_wheel + +# 5. (If needed) Install twine. + +# 6. Upload wheel and source files to the PyPI repository. +twine upload dist/* + +# 7. (Optional) Upload to Anaconda repository. +~/anaconda3/bin/anaconda upload dist/*.tar.gz +# or +anaconda upload dist/*.tar.gz + +# 8. Publish a new release at GitHub. +## Create a tag at GitHub. +## Make sure that it is created in the main branch. +## Assign the tag to a new release. +## The name convention of tags is "v0.5.5". +## Upload the wheel and source files, which can be downloaded from the PyPI repository, together. + +# 9. Check out Zenodo or upload the release on Zenodo. +## To upload the release, download a ZIP file from a particular tag.