Skip to content

chore: Add release docs and workflow - #313

Merged
camdecoster merged 10 commits into
mainfrom
cam/312/add-release-docs
Sep 18, 2026
Merged

camdecoster merged 10 commits into
mainfrom
cam/312/add-release-docs

Conversation

@camdecoster

Copy link
Copy Markdown
Contributor

Description

Add docs covering release and add/update workflows to enable release via OIDC.

Closes #307.
Closes #312.

Changes

  • Add docs
  • Pin actions via commit hash
  • Remove publish step to TestPyPI
  • Fix flaky test (hopefully)
  • Pin ruff version across repo
  • Remove obsolete version file (that wasn't being used anyway)

Testing

  • Review the docs
  • Check the results of CI
  • Once merged, try running the publish workflow against the v1.4.0 tag (it should be a no-op since that version is already published, but it will test the workflow)

@KoolADE85 KoolADE85 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice improvement! 💃

Comment thread tests/test_devtools_async_helpers.py Outdated
Comment on lines +17 to +31
# Create a simple HTML page as a data URL
data_url = "https://www.example.com"
# Create a simple HTML page as a data URL. Real URLs are flaky, so do this.
data_url = "data:text/html,<h1>hi</h1>"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Errata contradicts the data_url - not sure if the comment is still relevant or not, but we should revert at least one of these!

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah! I didn't see that before. I'll revert the change. There's probably another direction we can go in.

Comment thread .github/workflows/test_and_build.yml Outdated

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there reason to exclude python 3.11?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not that I'm aware of. Looking at the history, it seems like a mistake. I'll add it.

@camdecoster
camdecoster merged commit 551cc06 into main Sep 18, 2026
5 of 7 checks passed
@camdecoster
camdecoster deleted the cam/312/add-release-docs branch September 18, 2026 12:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[CHORE]: Add release docs [CHORE]: Pin ruff to specific version across repo/CI

2 participants