Merge pull request #58 from brootware/dev

Dev

.github/workflows/deploy.yml

@@ -0,0 +1,54 @@
+# Automatically pull down the required versions of windows plugins
+# and bundle them up for releases. This makes staging on non-internet
+# connected systems easier.
+name: "DEPLOY"
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/')
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Python 3.9
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.9"
+
+      - name: Installing Python Poetry
+        run: pip install poetry
+
+      - name: Install and Build pwncat-cs Package
+        run: |
+          poetry install
+          poetry build
+
+      - name: Publish Package to TestPyPi
+        run: |
+          # Test that package publishing is going to work with the testpypi
+          # instance first before trying to package plugins.
+          poetry config pypi-token.testpypi ${{ secrets.TEST_PYPI_TOKEN }}
+          poetry config repositories.testpypi https://test.pypi.org/legacy/
+          poetry publish --repository testpypi
+
+      - name: Publish Package to PyPi
+        run: |
+          # Everything looks good, publish to pypi
+          poetry config pypi-token.pypi ${{ secrets.PYPI_TOKEN }}
+          poetry publish
+
+      - name: Extract Release Body
+        run: |
+          # Grab tag name without the `v`
+          version=$(git describe --tags --abbrev=0 | sed 's/v//')
+          # build a changelog with just logs from this release
+          echo "## Changelog" >> this_version_changelog.md
+          cat CHANGELOG.md | sed -n '/^## \['"$version"'\]/,/^## /p' | head -n -1 | tail -n +2 >> this_version_changelog.md
+          echo "[Full Changelog](https://github.com/brootware/PyRedactKit/blob/v$version/CHANGELOG.md)" >> this_version_changelog.md

CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+The Changelog starts with v0.3.3, because we did not keep one before that,
+and simply didn't have the time to go back and retroactively create one.
+
+## [Unreleased]
+
+### Fixed
+
+- None at the moment.
+
+### Added
+
+- None at the moment.
+
+## [0.3.4] - 2022-07-24
+
+Added API support to identify core redaction patterns.
+
+### Changed
+
+- No notable changes in CLI functionality
+
+## [0.3.3] - 2022-07-24
+
+Started automating Pypi publishing via github actions.
+
+### Changed
+
+- No notable changes.