Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Eric/cus 10 add automation for deploying to test pypi and prod #32

Merged

Conversation

flowstate
Copy link
Collaborator

@flowstate flowstate commented Nov 6, 2024

Add GitHub Actions for Automated Deployments

This PR introduces automated deployment workflows using GitHub Actions, establishing a standardized release process for both PyPI packages and Docker images.

New Workflows

PR Previews

  • Automatically builds and publishes preview versions to Test PyPI
  • Creates preview Docker images
  • Comments on PR with installation instructions
  • Enforces version number increments

Release Process

  • Automated releases triggered by pushing a git tag (e.g., v1.2.3)
  • Publishes to PyPI
  • Pushes Docker images with latest and version tags
  • This is idempotent to support re-running if there's a partial deploy

Manual Stable Releases

  • Manual workflow to mark specific versions as "stable"
  • Updates Docker stable tag

Version Management

  • Enforces version increments on PRs
  • Versions managed in code (__init__.py)
  • Git tags must match a published code version (prefixed with 'v')

New Development Workflow

  1. Create feature branch
  2. Update code and increment version
  3. Create PR → Preview build created
  4. Merge PR
  5. Create git tag → Production release
  6. (Optional) Mark as stable

This PR includes version bump to 1.0.36 to establish clean starting point for automated processes (version .35 was pushed to deploy reversions).

@flowstate flowstate requested a review from a team as a code owner November 6, 2024 20:37
@flowstate flowstate requested review from bmeck, alxhotel and dacoburn and removed request for a team November 6, 2024 20:37
@flowstate
Copy link
Collaborator Author

testing comments endpoint

Copy link

github-actions bot commented Nov 6, 2024

🚀 Preview package published!

Install with:

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple socketsecurity==1.0.36.dev3221

Docker image: socketdev/cli:pr-32

Copy link

github-actions bot commented Nov 6, 2024

🚀 Preview package published!

Install with:

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple socketsecurity==1.0.36.dev3212

Docker image: socketdev/cli:pr-32

Copy link

github-actions bot commented Nov 6, 2024

🚀 Preview package published!

Install with:

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple socketsecurity==1.0.36.dev3213

Docker image: socketdev/cli:pr-32

Copy link

github-actions bot commented Nov 6, 2024

🚀 Preview package published!

Install with:

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple socketsecurity==1.0.36.dev3214

Docker image: socketdev/cli:pr-32

Copy link

github-actions bot commented Nov 6, 2024

🚀 Preview package published!

Install with:

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple socketsecurity==1.0.36.dev3215

Docker image: socketdev/cli:pr-32

Copy link

github-actions bot commented Nov 6, 2024

🚀 Preview package published!

Install with:

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple socketsecurity==1.0.36.dev3216

Docker image: socketdev/cli:pr-32

Copy link

github-actions bot commented Nov 7, 2024

🚀 Preview package published!

Install with:

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple socketsecurity==1.0.36.dev3217

Docker image: socketdev/cli:pr-32

Copy link

github-actions bot commented Nov 7, 2024

🚀 Preview package published!

Install with:

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple socketsecurity==1.0.36.dev3218

Docker image: socketdev/cli:pr-32

Copy link

github-actions bot commented Nov 7, 2024

🚀 Preview package published!

Install with:

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple socketsecurity==1.0.36.dev3219

Docker image: socketdev/cli:pr-32

@flowstate flowstate merged commit 09995c3 into main Nov 19, 2024
6 checks passed
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