From 50d8a30ab5822f5a2a6eddb9d4fc4a9a26cba732 Mon Sep 17 00:00:00 2001
From: Mayank Nader <mayank.nader11@gmail.com>
Date: Sun, 9 Oct 2022 19:19:32 +0530
Subject: [PATCH] chore(readme): add steps for pushing a new update

---
 README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)

diff --git a/README.md b/README.md
index 39a3a2c..8a22dd7 100644
--- a/README.md
+++ b/README.md
@@ -49,6 +49,7 @@ Jump to:
   - [Environment error](#could-not-install-package-due-to-environment-error)
   - [ghs command not found](#ghs-command-not-found-even-after-installing)
 - [How to contribute?](#how-to-contribute)
+- [Steps for pushing a new update](#steps-for-pushing-a-new-update)
 - [Changelog](#changelog)
 - [Privacy Notice](#privacy-notice)
 - [License](#license)
@@ -166,6 +167,60 @@ Most likely the place where the command is installed is not in the system [PATH]
 
 Please see [Contributing guidelines](https://github.com/interviewstreet/ghs/blob/master/CONTRIBUTING.md) for more information.
 
+## Steps for pushing a new update
+
+1. Bump the version in `ghs/__init__.py` (we follow semantic versioning)
+
+2. Create an annotated tag for this commit with the version name `git tag -a v1.2.3 -m "v1.2.3"`. You can use this to publish a new release on the project github page and the same can be used for maintaining the changelog.
+
+3. Make sure you have [twine](https://pypi.org/project/twine/) and [build](https://pypi.org/project/build/) installed.
+
+```
+pip install build twine
+```
+
+3. Build the package
+
+```
+python -m build
+```
+
+This will create a source archive and a wheel inside the `dist` folder. You can inspect them to make sure that they contain the correct files.
+
+4. Run twine sanity on the build files
+
+```
+twine check dist/*
+```
+
+5. First push the package on [TestPyPi](https://test.pypi.org/) so that you can test the updates without affecting the real PyPI index
+
+```
+twine upload -r testpypi dist/*
+
+```
+
+> Get the credentials for hackerrank dev PyPI account from karthik.
+
+6. First push the package on [TestPyPi](https://test.pypi.org/) so that you can test the updates without affecting the real PyPI index
+
+```
+twine upload -r testpypi dist/*
+
+```
+
+> Get the credentials for hackerrank dev PyPI account from karthik.
+
+Twine will list the package url on TestPyPI. You can test and confirm your changes by installing the package.
+
+7. Finally, run the following command to upload the package to PyPI
+
+```
+twine upload dist/*
+```
+
+8. Treat yourself with a scoop of tender coconut.
+
 ## Changelog
 
 You can checkout [Releases](https://github.com/interviewstreet/ghs/releases) for the changelog.