Update README.md and add publish_new_release.txt

jungtaekkim · Nov 21, 2023 · 915e15b · 915e15b
1 parent d62e1a0
commit 915e15b
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
 <p align="center">
-<img src="https://github.com/jungtaekkim/bayeso/blob/main/docs/_static/assets/logo_bayeso_capitalized.svg" width="400" />
+<img src="https://raw.githubusercontent.com/jungtaekkim/bayeso/main/docs/_static/assets/logo_bayeso_capitalized.svg" width="400" />
 </p>
 
 # 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
diff --git a/publish_new_release.txt 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.