bad readme caused twine upload to fail

2bndy5 · Jul 25, 2021 · d1aadde · d1aadde
1 parent 399d521
commit d1aadde
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 31 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -18,7 +18,7 @@ jobs:
       - name: Checkout this Repo
         uses: actions/checkout@v2
 
-      - name: Set up Python ${{ matrix.python-version }}
+      - name: Set up Python
         uses: actions/setup-python@v2
         with:
           python-version: 3.7
@@ -27,23 +27,22 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements.txt
-          pip install pylint
+          pip install --upgrade setuptools wheel twine pylint
 
       - name: Check formatting
         run: pylint rmskin_builder.py
 
-      - name: Prepare for pypi
-        if: github.event_name == 'release'
-        run: pip install setuptools wheel twine
+      - name: twine Check
+        run: |
+          python setup.py sdist
+          twine check dist/*
 
-      - name: Build and publish
+      - name: twine Upload
         if: github.event_name == 'release'
         env:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.pypi_token }}
-        run: |
-          python setup.py sdist
-          twine upload dist/*
+        run: twine upload dist/*
 
   Build:
     runs-on: ubuntu-latest

diff --git a/README.rst b/README.rst
@@ -14,37 +14,36 @@ A Python-based Github action tool to package a Repository's Rainmeter Content in
 Input Arguments
 ===============
 
-    .. csv-table::
-        :header: "Argument", "Description", "Required"
-        :widths: 5, 15, 3
-
-        "version", "Version of the Rainmeter rmskin package. Defaults to last 8 digits of SHA from commit or ref/tags", "no"
-        "title", "Name of the Rainmeter rmskin package. Defaults to name of repository", "no"
-        "author", "Account Username maintaining the rmskin package. Defaults to Username that owns the repository.", "no"
-        "path", "Base directory of repo being packaged. Defaults to workflow's workspace path", "no"
-        "dir_out", "Path to save generated rmskin package. Defaults to workflow's workspace path", "no"
-
-    .. note::
-        You can use your repository's ``RMSKIN.ini`` file to override any above inputs except ``dir_out`` & ``path`` inputs.
+.. csv-table::
+    :header: "Argument", "Description", "Required"
+    :widths: 5, 15, 3
+
+    "version", "Version of the Rainmeter rmskin package. Defaults to last 8 digits of SHA from commit or ref/tags", "no"
+    "title", "Name of the Rainmeter rmskin package. Defaults to name of repository", "no"
+    "author", "Account Username maintaining the rmskin package. Defaults to Username that owns the repository.", "no"
+    "path", "Base directory of repo being packaged. Defaults to workflow's workspace path", "no"
+    "dir_out", "Path to save generated rmskin package. Defaults to workflow's workspace path", "no"
+.. note::
+    You can use your repository's ``RMSKIN.ini`` file to override any above inputs except ``dir_out`` & ``path`` inputs.
 
 Output Arguments
 ================
 
-    * ``arc_name`` : The name of the generated rmskin file saved in the
-      path specified by ``dir_out`` input argument.
+* ``arc_name`` : The name of the generated rmskin file saved in the
+  path specified by ``dir_out`` input argument.
 
 Ideal Repo Structure
 ====================
 
 - root directory
 
-    * ``Skins``      <- a folder to contain all necessary Rainmeter skins
-    * ``RMSKIN.ini`` <- list of options specific to installing the skin(s)
-    * ``Layouts``    <- a folder that contains Rainmeter layout files
-    * ``Plugins``    <- a folder that contains Rainmeter plugins
-    * ``@Vault``     <- resources folder accessible by all installed skins
+  - ``Skins``       a folder to contain all necessary Rainmeter skins
+  - ``RMSKIN.ini``  list of options specific to installing the skin(s)
+  - ``Layouts``     a folder that contains Rainmeter layout files
+  - ``Plugins``     a folder that contains Rainmeter plugins
+  - ``@Vault``      resources folder accessible by all installed skins
 
-.. seealso::
+.. tip::
     `A cookiecutter repository <https://github.com/2bndy5/Rainmeter-Cookiecutter>`_
     has also been created to facilitate development of Rainmeter skins on Github
     quickly.

diff --git a/setup.py b/setup.py
@@ -5,15 +5,14 @@
 https://github.com/pypa/sampleproject
 """
 import os
-from codecs import open as open_codec  # To use a consistent encoding
 from setuptools import setup
 
 
 ROOT_DIR = os.path.abspath(os.path.dirname(__file__))
 REPO = "https://github.com/2bndy5/rmskin-action"
 
 # Get the long description from the README file
-with open_codec(os.path.join(ROOT_DIR, "README.rst"), encoding="utf-8") as f:
+with open(os.path.join(ROOT_DIR, "README.rst", "r", encoding="utf-8"), encoding="utf-8") as f:
     long_description = f.read()
 
 setup(