Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 27, 2025

Added documentation section describing the automated release workflow for vbl-aquarium.

Changes

  • Added "Deploying New Releases" section to docs/home/development.md
  • Documents tag-based release trigger (v* pattern)
  • Describes automated pipeline: Hatch build → PyPI publish → GitHub release creation
  • Includes pre-release detection logic (versions containing a, b, c, or d)

The workflow is triggered by:

git tag v<version>
git push origin v<version>

References the release workflow for implementation details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • docs.pydantic.dev
    • Triggering command: /home/REDACTED/.local/share/hatch/env/virtual/vbl-aquarium/sNmpyHd7/docs/bin/mkdocs mkdocs build (dns block)
  • docs.python.org
    • Triggering command: /home/REDACTED/.local/share/hatch/env/virtual/vbl-aquarium/sNmpyHd7/docs/bin/mkdocs mkdocs build (dns block)
  • ephys-link.virtualbrainlab.org
    • Triggering command: /usr/bin/curl curl -s REDACTED (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

add a section to the dev documentation that describes how publishing new version vbl-aquarium is a tag push using the desired version number and an action will build from main, publish to pypi, and make a new github release. Use the documentation here as an example: https://ephys-link.virtualbrainlab.org/development/#deploying-new-releases


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI changed the title [WIP] Add section on publishing new version vbl-aquarium docs: add release process documentation Dec 27, 2025
Copilot AI requested a review from kjy5 December 27, 2025 23:07
@kjy5 kjy5 marked this pull request as ready for review December 27, 2025 23:30
Copilot AI review requested due to automatic review settings December 27, 2025 23:30
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds comprehensive documentation for the automated release process of vbl-aquarium. The documentation explains how maintainers can trigger releases through git tags, which initiates an automated pipeline that builds, publishes to PyPI, and creates GitHub releases.

  • Added "Deploying New Releases" section with step-by-step release instructions
  • Documents the tag-based trigger pattern (v*) and automated workflow steps
  • Includes note about pre-release version detection logic

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@kjy5 kjy5 merged commit f9fa1da into main Dec 27, 2025
11 checks passed
@kjy5 kjy5 deleted the copilot/add-documentation-for-publishing branch December 27, 2025 23:32
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.

2 participants