Adding Auto Distribution to Github Actions (#5)

.github/actions/build-dist/action.sh

@@ -0,0 +1,8 @@
+set -euo pipefail
+
+echo "Ensuring pip is up to date"
+python -m pip install --upgrade pip
+echo "Installing the latest version of pypa/build"
+pip install build
+
+python -m build --sdist --wheel --outdir dist/ .

.github/actions/build-dist/action.yml

@@ -0,0 +1,8 @@
+name: "Build Python package"
+description: "Build a wheel and sdist for the package"
+runs:
+  using: "composite"
+  steps:
+    - name: "Build wheel"
+      run: "$GITHUB_ACTION_PATH/action.sh"
+      shell: "bash"

.github/actions/verify-wheel/action.sh

@@ -0,0 +1,19 @@
+set -euo pipefail
+
+MODULE_NAME=$1
+WHEEL_LOCATION=$2
+
+echo "Ensuring pip is up to date"
+python -m pip install --upgrade pip
+
+APP_DIR=$(pwd)
+
+# move into root dir so Python will import the installed package instead of the local source files
+cd /
+echo "------------------"
+echo "Installing package"
+pip install ${APP_DIR}/${WHEEL_LOCATION}/*.whl
+
+echo "-----------------------------"
+echo "Attempting to import package"
+python "${GITHUB_ACTION_PATH}/test_module_import.py" "${MODULE_NAME}"

.github/actions/verify-wheel/action.yml

@@ -0,0 +1,16 @@
+name: "Verify Python Wheel"
+description: "Verify importing the package doesn't cause an error"
+inputs:
+  package-import-name:
+    description: "Name used to import the package from python code"
+    required: true
+  packages-dir:
+    description: The target directory for distribution
+    required: false
+    default: dist
+runs:
+  using: "composite"
+  steps:
+    - name: "Verify wheel"
+      run: "$GITHUB_ACTION_PATH/action.sh ${{ inputs.package-import-name }} ${{ inputs.packages-dir }}"
+      shell: "bash"

.github/actions/verify-wheel/test_module_import.py

@@ -0,0 +1,15 @@
+import importlib
+import sys
+
+try:
+    module_name = sys.argv[1]
+except IndexError:
+    print("module_name must be provided as first argument to test_module_import.py script")
+    sys.exit(1)
+
+try:
+    module = importlib.import_module(module_name)
+except Exception as e:
+    print(f"Error importing module {module_name}: {e}")
+    sys.exit(1)
+print(f"Imported {module_name} version {module.__version__}")

.github/workflows/lint.yml

@@ -0,0 +1,21 @@
+name: lint
+
+on: # Rebuild any PRs and main branch changes
+  push:
+    branches:
+      - main
+      - develop
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out code
+      uses: actions/checkout@v3
+
+    - name: Lint Markdown files
+      uses: avto-dev/markdown-lint@v1
+      with:
+        config: '.markdownlint.json'
+        args: '**/*.md .github/**/*.md'

.github/workflows/main.yml

@@ -0,0 +1,42 @@
+name: CI
+
+# Triggers the workflow on push or pull request
+# events but only for the main branch
+on: [push, pull_request]
+
+env:
+  PYTHON_VERSION: "3.9"
+
+jobs:
+  test:
+    runs-on: "ubuntu-latest"
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8, 3.9]
+    steps:
+        - name: "Check out code"
+          uses: "actions/checkout@v2"
+        - uses: "actions/setup-python@v2"
+          with:
+            python-version: ${{ matrix.python-version }}
+        - name: "Install dependencies"
+          run: |
+            python -m pip install --upgrade pip
+            python -m pip install tox tox-gh-actions
+        - name: Test with tox
+          run: tox
+
+  verify-wheel:
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Check out code"
+        uses: "actions/checkout@v2"
+      - uses: "actions/setup-python@v2"
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      - name: "Build wheel"
+        uses: "./.github/actions/build-dist"
+      - name: "Verify wheel"
+        uses: "./.github/actions/verify-wheel"
+        with:
+          package-import-name: "pytest_eucalyptus"

.github/workflows/publish_release.yml

@@ -0,0 +1,27 @@
+name: Publish Release
+env:
+  PYTHON_VERSION: "3.9"
+on:
+  release:
+    types: [published]
+jobs:
+  build-and-publish-wheel-to-pypi:
+    runs-on: "ubuntu-latest"
+    environment: "Publish Release"
+    steps:
+      - name: "Check out code"
+        uses: "actions/checkout@v2"
+
+      - uses: "actions/setup-python@v2"
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: "Build wheel"
+        uses: "./.github/actions/build-dist"
+
+        # v1.4.2 release. Using full SHA for security
+        # https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
+      - name: "Publish distribution 📦 to PyPI"
+        uses: "pypa/gh-action-pypi-publish@717ba43cfbb0387f6ce311b169a825772f54d295"
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

.markdownlint.json

@@ -0,0 +1,13 @@
+{
+    "default": true,
+    "MD013": {
+        "line_length": 10000,
+        "headings": false,
+        "code_blocks": false,
+        "tables": false
+    },
+    "MD024": {
+        "siblings_only": true
+    },
+    "MD041": false
+}

CODE_OF_CONDUCT.md

@@ -0,0 +1,133 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement by contacting [a
+project maintainer][maintainers].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
+[maintainers]: MAINTAINERS.md

CONTRIBUTING.md

@@ -0,0 +1,47 @@
+# How to Contribute
+
+Thanks for your interest in contributing to `pytest-eucalyptus`! Here are a few general guidelines on contributing and
+reporting bugs that we ask you to review. Following these guidelines helps to communicate that you respect the time of
+the contributors managing and developing this open source project. In return, they should reciprocate that respect in
+addressing your issue, assessing changes, and helping you finalize your pull requests. In that spirit of mutual respect,
+we endeavour to review incoming issues and pull requests within 10 days, and will close any lingering issues or pull
+requests after 60 days of inactivity.
+
+Please note that all of your interactions in the project are subject to our [Code of Conduct](CODE_OF_CONDUCT.md). This
+includes creation of issues or pull requests, commenting on issues or pull requests, and extends to all interactions in
+any real-time space (eg. Slack, Discord, etc).
+
+## Reporting Issues
+
+Before reporting a new issue, please ensure that the issue was not already reported or fixed by searching through our
+[issues list](https://github.com/wayfair/pytest-eucalyptus/issues).
+
+When creating a new issue, please be sure to include a **title and clear description**, as much relevant information as
+possible, and, if possible, a test case.
+
+**If you discover a security bug, please do not report it through GitHub. Instead, please see security procedures in
+[SECURITY.md](SECURITY.md).**
+
+## Sending Pull Requests
+
+Before sending a new pull request, take a look at existing pull requests and issues to see if the proposed change or fix
+has been discussed in the past, or if the change was already implemented but not yet released.
+
+We expect new pull requests to include tests for any affected behavior, and, as we follow semantic versioning, we may
+reserve breaking changes until the next major version release.
+
+## Other Ways to Contribute
+
+We welcome anyone that wants to contribute to `pytest-eucalyptus` to triage and reply to open issues to help troubleshoot
+and fix existing bugs. Here is what you can do:
+
+- Help ensure that existing issues follows the recommendations from the _[Reporting Issues](#reporting-issues)_ section,
+  providing feedback to the issue's author on what might be missing.
+- Review and update the existing content of our [Wiki](https://github.com/wayfair/pytest-eucalyptus/wiki) with up-to-date
+  instructions and code samples.
+- Review existing pull requests, and testing patches against real existing applications that use `pytest-eucalyptus`.
+- Write a test, or add a missing test case to an existing test.
+
+Thanks again for your interest on contributing to `pytest-eucalyptus`!
+
+:heart:

MAINTAINERS.md

@@ -0,0 +1,3 @@
+# Maintainers
+
+- [tscalzo000](https://github.com/tscalzo000)