Create action

.github/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 at
+<mailto:[email protected]>.
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+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.1]: https://www.contributor-covenant.org/version/2/1/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

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+---
+github: hynek
+ko_fi: the_hynek

.github/workflows/main.yml

@@ -0,0 +1,31 @@
+---
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+env:
+  FORCE_COLOR: "1" # Make tools pretty.
+
+jobs:
+  check-structlog:
+    name: Build & verify the structlog package.
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          repository: hynek/structlog
+          path: structlog
+
+      - uses: actions/checkout@v3
+        with:
+          path: action
+
+      - uses: ./action
+        with:
+          path: structlog

.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+---
+ci:
+  autoupdate_schedule: monthly
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml

README.md

@@ -0,0 +1,40 @@
+# build-and-inspect-python-package
+
+> **Warning**
+> This is alpha software and may change before v1.
+
+This action provides the following functionality for GitHub Actions users that are maintaining Python PyPI packages:
+
+1. Build your package using PyPA's [*build*](https://pypi.org/project/build/),
+1. upload the *wheel* and the source distribution (*SDist*) as artifacts so you can download and inspect them from the Summary view of a Actions run,
+1. lint the wheel using [*check-wheel-contents*](https://pypi.org/project/check-wheel-contents/),
+1. lint the PyPI README of both *wheel* and *SDist* using [*twine*](https://pypi.org/project/twine/),
+1. print you the tree of both *SDist* and *wheel* in the CI output so you don't have to download the packages just to check the contents.
+
+This way you can make package verification part of your CI.
+
+> **Note**
+> This action does **not** upload your package to PyPI.
+
+
+## Usage
+
+```yaml
+jobs:
+  check-package:
+    name: Build & inspect our package.
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: hynek/build-and-inspect-python-package@v0
+```
+
+### Optional Inputs
+
+- `path`: the location of the Python package to build (default: `.`).
+
+
+## License
+
+The scripts and documentation in this project are released under the [MIT License](LICENSE).

action.yml

@@ -0,0 +1,55 @@
+---
+name: Build and Inspect a Python Package
+description: Builds the current package using standard PyPA tooling, keeps it as artifacts, then performs basic checks on it.
+author: Hynek Schlawack
+branding:
+  icon: package
+  color: purple
+
+inputs:
+  path:
+    description: Where to look for the Python package to inspect.
+    required: false
+    default: .
+
+runs:
+  using: composite
+  steps:
+    - run: python -m pip install build twine check-wheel-contents wheel
+      shell: bash
+
+    # Build SDist, then build wheel out of it.
+    - run: python -m build
+      shell: bash
+      working-directory: ${{ inputs.path }}
+
+    # Give user overview over what we've built.
+    - run: ls -l dist
+      shell: bash
+      working-directory: ${{ inputs.path }}
+
+    - name: Upload built artifacts.
+      uses: actions/upload-artifact@v3
+      with:
+        name: Packages
+        path: ${{ inputs.path }}/dist/*
+
+    - run: check-wheel-contents dist/*.whl
+      shell: bash
+      working-directory: ${{ inputs.path }}
+
+    - name: Check PyPI README
+      shell: bash
+      run: python -m twine check dist/*
+      working-directory: ${{ inputs.path }}
+
+    - name: Show wheel & SDist contents hierarchically.
+      shell: bash
+      working-directory: ${{ inputs.path }}
+      run: |
+        cd dist
+        mkdir -p out/wheels
+        python -m wheel unpack --dest out/wheels *.whl
+        mkdir -p out/sdist
+        tar xf *.tar.gz -C out/sdist
+        tree -a out