Deploy releases (#11)

* Added new workflow for publishing releases

Signed-off-by: Courtney Caldwell <courtneyccaldwell@gmail.com>

* Adding any updates needed

Signed-off-by: Courtney Caldwell <courtneyccaldwell@gmail.com>

* Updated readme

Signed-off-by: Courtney Caldwell <courtneyccaldwell@gmail.com>

---------

Signed-off-by: Courtney Caldwell <courtneyccaldwell@gmail.com>

.github/workflows/deploy.yml

@@ -0,0 +1,28 @@
+name: Publish ${package_name} to PyPI / GitHub
+
+on:
+  release:
+    types: [published]
+
+jobs:
+    build-n-publish:
+        name: Build and publish to PyPI
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+            - name: Setup Python 3.10
+              uses: actions/setup-python@v5
+              with:
+                python-version: '3.10' 
+            - name: Install dependencies
+              run: |
+                python -m pip install --upgrade pip
+                pip install poetry
+                poetry install
+            - name: Setup Key
+              run: |
+               poetry config pypi-token.pypi "${{ secrets.PYPI_API_KEY }}"
+            - name: Publish to PyPI
+              run: |
+                poetry publish --build
+            

.github/workflows/testing.yml

@@ -24,13 +24,6 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
-    - uses: actions/cache@v3
-      id: cache
-      with:
-        path: ~/.cache/pip
-        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.*') }}
-        restore-keys: | 
-          ${{ runner.os }}-pip-
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip

README.md

@@ -18,6 +18,11 @@ See the API documentation on the [FabricPlus Website](https://fabricplus.prokopt
 
 See [`fabric`](https://github.com/fabric/fabric) for more details on the base `fabric` library, if interested in the underlying behaviors. Some have been changed: see Important Changes and the documentation for more information.
 
+## Note On Changelogs
+
+- Changelog will be implemented AFTER 1.0, given that 1.0 was considered MVP and all features should be stable.
+- Docs will continue to be updated throughout, inbetween release versions.
+
 ## Installation
 
 ### pip (via PyPI)
@@ -86,28 +91,8 @@ conn_1.get("/path/to/some/remote/file", scp=True)
 conn_1.su("date", user="someotheruser", password="someuserspasswd")
 ```
 
-## Timeline
-
-
-- [x] Finish initial feature builds with
-  - Interopability with base `Connection`
-  - Added `paramiko-jump` compatibility
-  - Added `scp` compatibility
-  - Added `su` compatibility
-- [x] Finish typing, docstrings, and consistency checks
-- [x] Set up auto-generating documentation
-- [ ] Set up automated unit testing
-- [ ] Set up automated building
-- [ ] Publish 1.0 to PyPI
-
 License Addendum
 ----------------
 - [`scp.py`](https://github.com/jbardin/scp.py) is used by import under the LGPL v2.1 license, and this notice is in accordance with that license.
 - [`paramiko-jump`](https://github.com/andrewschenck/paramiko-jump) used under Apache License 2.0, see `fabricplus/paramiko_modifications/client.py` for license details.
-- [`fabric`](https://github.com/fabric/fabric) is used, and falls under a BSD-2-Clause license, which doesn't restrict its use as an imported library, but is noted here anyways.
-
-TODO
-----
-
-- [ ] Add some unit testing
-- [ ] Define version compatibility for Fabric/Invoke/Paramiko
+- [`fabric`](https://github.com/fabric/fabric) is used, and falls under a BSD-2-Clause license, which doesn't restrict its use as an imported library, but is noted here anyways.