ci: add release workflow and instructions (#3)

Author: wendychiang

.github/workflows/ci.yml

@@ -9,13 +9,11 @@ jobs:
   tests:
     name: Format and Tests
     runs-on: "${{ matrix.os }}"
-    continue-on-error: ${{ matrix.experimental }}
     strategy:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
         python-version: ['3.7', '3.8', '3.9', '3.10']
-        experimental: [false]
         include:
           - os: ubuntu-latest
           - os: windows-latest
@@ -37,36 +35,10 @@ jobs:
         shell: bash
         run: echo ::set-output name=version::$(python -c "import sys; print('-'.join(str(v) for v in sys.version_info))")
 
-      - name: Bootstrap poetry
-        shell: bash
-        run: |
-          curl -sL https://raw.githubusercontent.com/python-poetry/poetry/master/install-poetry.py \
-            | python - -y ${{ matrix.bootstrap-args }}
-      - name: Update PATH
-        if: ${{ matrix.os != 'windows-latest' }}
-        shell: bash
-        run: echo "$HOME/.local/bin" >> $GITHUB_PATH
-
-      - name: Update Path for Windows
-        if: ${{ matrix.os == 'windows-latest' }}
-        shell: bash
-        run: echo "$APPDATA\Python\Scripts" >> $GITHUB_PATH
-
-      - name: Configure poetry
-        shell: bash
-        run: poetry config virtualenvs.in-project true
-
-      - name: Set up cache
-        uses: actions/cache@v2
-        id: cache
-        with:
-          path: .venv
-          key: venv-${{ runner.os }}-${{ steps.full-python-version.outputs.version }}-${{ hashFiles('**/poetry.lock') }}
-
-      - name: Ensure cache is healthy
-        if: steps.cache.outputs.cache-hit == 'true'
-        shell: bash
-        run: timeout 10s poetry run pip --version || rm -rf .venv
+      - name: Install poetry
+        run:  |
+          pip install --upgrade pip
+          pip install --upgrade poetry
 
       - name: Install dependencies
         shell: bash
@@ -80,7 +52,7 @@ jobs:
         shell: bash
         run: poetry run lint
 
-      - name: Lint
+      - name: Type Check
         shell: bash
         run: poetry run type-check
 

.github/workflows/publish.yml

@@ -0,0 +1,26 @@
+name: publish
+
+on:
+  release:
+    types: [published] # Trigger when release is created
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
+    - name: Set up Python 3.7
+      uses: actions/setup-python@3105fb18c05ddd93efea5f9e0bef7a03a6e9e7df
+      with:
+        python-version: 3.7
+    - name: Install dependencies
+      run:  |
+        pip install --upgrade pip
+        pip install --upgrade poetry
+    - name: Publish with Poetry
+      run: |
+        poetry config repositories.pypi "https://pypi.org/legacy/"
+        poetry config pypi-token.pypi $PYPI_TOKEN
+        poetry publish --build
+      env:
+        PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}

CHANGELOG.md

@@ -0,0 +1,15 @@
+Version - Date
+(e.g v0.0.1 - 19 Nov 2021)
+------------
+
+Bug fixes:
+
+* [#PR number](PR or issue link) description.
+
+Features:
+
+* [#PR number](PR or issue link) description.
+
+Other changes:
+
+* [#PR number](PR or issue link) description.

CONTRIBUTING.md

@@ -132,11 +132,11 @@ Install pyenv [here]https://github.com/pyenv/pyenv#installation)
 Install and set python version with pyenv:
 
 ```console
-pyenv install 3.7.8
-pyenv local 3.7.8
+pyenv install 3.9.9
+pyenv local 3.9.9
 ```
 
-Note: You are welcome to use any python version >= 3.7.1
+Note: You are welcome to use any python version between 3.7.1 and 3.10
 
 To validate that your poetry venv is using the correct python version
 

RELEASE.md

@@ -0,0 +1,40 @@
+# Issuing a New Release 
+
+The maintainers are able to issue a new release. The steps to publish release is a handful of manual steps since we want to ensure that issuing a release is a very conscious decision, requiring peer review, and cannot easily happen accidentally. There are main two steps to publish a new release:
+
+## 1. Create a Release PR
+
+* Create a new branch locally for the release, for example:
+
+  ```
+  git checkout -b releases/v0.1.0
+  ```
+
+* Tell Poetry to bump the version:
+  ```
+  poetry version [patch|minor|major]
+  ```
+  Note: This command is updating the version number in the pyproject.toml. You can totally do this manually. Helpful docs: [Poetry version command](https://python-poetry.org/docs/cli/#version), [Semantic Versioning](https://semver.org/)
+
+* Update the [CHANGELOG](CHANGELOG.md) with the appropriate new version number and release date with the clear description
+
+* Create a pull request for these changes, and get it approved
+
+## 2. Create a new release from Github Page
+
+Once your PR has been merged, the final piece is to actually create the new release.
+
+1. Go to the [sample-size releases page](https://github.com/godaddy/sample-size/releases) and click on `Create a new release`.
+
+1. Enter an appropriate tag version or create a new tag. Please prefix the version names with the letter `v`
+
+    ![release-tag](./docs/source/_static/release-tag.png)
+
+
+1. Title the release. Generally these would just be in the form `Sample-Size 0.1.0`
+
+1. Copy-paste the CHANGELOG entries for this new version into the description.
+
+1. Click `Publish release`!
+
+1. The publish workflow will be triggered automatically to release it to [PyPI](https://pypi.org/) for the new version!

docs/source/_static/release-tag.png

@@ -3,6 +3,10 @@ name = "sample-size"
 version = "0.0.1a1"
 description = "A python module implementing power analysis to estimate sample size"
 authors = []
+include = ["CHANGELOG.md", "README.md"]
+readme = "README.md"
+maintainers = ["GoDaddy <[email protected]>"]
+keywords = ["sample size", "experimentation", "power analysis"]
 
 [tool.poetry.dependencies]
 python = ">=3.7.1,<3.11"