diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d063089..d08c681 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -8,6 +8,10 @@ on: branches: - main + release: + types: + - published + jobs: sanity: name: run sanity checks @@ -149,3 +153,22 @@ jobs: with: files: ./coverage.xml flags: ${{ env.OS }},py${{ matrix.python-version }},ansible_${{ matrix.ansible-version }} + + publish: + name: publish + needs: + - test + runs-on: ubuntu-latest + permissions: + # IMPORTANT: this permission is mandatory for trusted publishing + id-token: write + + steps: + - uses: actions/download-artifact@v3 + with: + name: artifact + path: ./dist + + - name: Publish + if: startsWith(github.ref, 'refs/tags/v') + uses: pypa/gh-action-pypi-publish@release/v1 diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..8842f08 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog + +## 0.1.0 - 2023-11-13 + +Initial release of `ansibug` + +This version should be treated as a pre-release, any behavior may change in future versions depending on feedback. diff --git a/README.md b/README.md index 578c97c..554f00c 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,10 @@ [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jborean93/ansibug/blob/main/LICENSE) The core component of the Ansible Debug Adapter Protocol used for debugging Ansible playbooks. +See more documentation for `ansibug` at https://jborean93.github.io/ansibug/. + +Please note this library should be considered a preview. +New features and behaviour changes should be expected during this preview period. # Debug Adapter This library combined with a [Debug Adapter Protocol](https://microsoft.github.io/debug-adapter-protocol/) client, like Visual Studio Code, can be used to run and debug Ansible playbook's interactively. @@ -26,10 +30,10 @@ There are no guarantees that all features will be supported across Ansible versi Any such features will be explicitly called out in the documentation. # Installation -Currently this library has not been published on PyPI and must be installed manually from source with: +This library has been published on PyPI and can be installed with: ```bash -python -m pip install https://github.com/jborean93/ansibug/archive/main.zip +python -m pip install ansibug ``` To test out the changes locally run the following: