Skip to content

Commit

Permalink
Add more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
charliermarsh committed Jan 17, 2024
1 parent 61cc046 commit 43f9981
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 22 deletions.
5 changes: 4 additions & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
name: "[ruff] Build"
# Build Ruff on all platforms.
#
# Generates both wheels (for PyPI) and archived binaries (for GitHub releases).
name: Build

on:
workflow_call:
Expand Down
7 changes: 5 additions & 2 deletions .github/workflows/notify-dependents.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Notifies downstream repositories of a new release.
name: NotifyDependents
# Notify downstream repositories of a new release.
#
# Assumed to run as a subworkflow of .github/workflows/release.yml; specifically, as a post-announce
# job within `cargo-dist`.
name: Notify dependents

on:
workflow_call:
Expand Down
22 changes: 5 additions & 17 deletions .github/workflows/publish-docker.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Publishes a Docker image to ghcr.io.
name: PublishDocker
# Publish a Docker image to ghcr.io.
#
# Assumed to run as a subworkflow of .github/workflows/release.yml; specifically, as a publish job
# within `cargo-dist`.
name: Publish Docker

on:
workflow_call:
Expand Down Expand Up @@ -37,21 +40,6 @@ jobs:
with:
images: ghcr.io/astral-sh/ruff

- name: Check tag consistency
# Unlike validate-tag we don't check if the commit is on the main branch, but it seems good enough since we can
# change docker tags
if: ${{ fromJson(inputs.plan).tag != 'dry-run' }}
run: |
version=$(grep "version = " pyproject.toml | sed -e 's/version = "\(.*\)"/\1/g')
if [ "${{ fromJson(inputs.plan).tag }}" != "${version}" ]; then
echo "The input tag does not match the version from pyproject.toml:" >&2
echo "${{ fromJson(inputs.plan).tag }}" >&2
echo "${version}" >&2
exit 1
else
echo "Releasing ${version}"
fi
- name: "Build and push Docker image"
uses: docker/build-push-action@v5
with:
Expand Down
7 changes: 5 additions & 2 deletions .github/workflows/publish-pypi.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Publishes a release to PyPI.
name: PublishPyPI
# Publish a release to PyPI.
#
# Assumed to run as a subworkflow of .github/workflows/release.yml; specifically, as a publish job
# within `cargo-dist`.
name: Publish PyPI

on:
workflow_call:
Expand Down

0 comments on commit 43f9981

Please sign in to comment.