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

GitHub Actions for Automated Nightly and Official Releases #2

Merged
merged 1 commit into from
Jun 28, 2024

Conversation

renxida
Copy link
Owner

@renxida renxida commented Jun 28, 2024

Overview

This PR refactors our GitHub Actions workflows to implement a new release strategy. The new approach automates the creation of nightly releases and simplifies the process of creating official releases.

Changes

1. New Workflow: Nightly Releases (nightly-release.yml)

  • Automatically creates a nightly release on every push to the main branch and on every pull request.
  • Generates a version number in the format X.Y.Z-nightly.{run_number}.
  • Creates a GitHub pre-release with the nightly version tag.

2. Modified Workflow: Official Releases (release.yml)

  • Updated to automatically select the latest nightly release when triggered.
  • Removes the need for manual input of the nightly release tag.
  • Creates an official release based on the latest nightly, updating version numbers in files.

3. Modified Workflow: Package Publishing (publish.yml)

  • Now triggers only on official release tags (v*..).
  • Publishes the package to PyPI when an official release is created.

Benefits

  1. Automated Nightly Builds: Provides easy access to the latest changes for testing.
  2. Simplified Release Process: Official releases can be created with a single click, without manual version selection.
  3. Consistent Versioning: Ensures a clear progression from nightly to official releases.
  4. Automated Publishing: Reduces manual steps in the release process.

How to Use

  1. Nightly releases will be automatically created on pushes and pull requests.
  2. To create an official release:
    a. Go to the "Actions" tab in the GitHub repository.
    b. Select the "Official Release" workflow.
    c. Click "Run workflow" without any additional input.
  3. The publish workflow will automatically triggered

@renxida renxida merged commit 6fe076e into main Jun 28, 2024
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.

1 participant