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

ci: Automate release of NeMo Toolkit #9453

Closed
wants to merge 2 commits into from

Conversation

ko3n1g
Copy link
Collaborator

@ko3n1g ko3n1g commented Jun 12, 2024

What does this PR do ?

Automates releases of NeMo Toolkit.

The automation starts with a manual workflow that can be dispatched via GitHubs Workflow UI.

After selecting the type of version bump (MAJOR, MINOR, PATCH, PRE_RELEASE) it creates a release pull request.

That PR contains two comments that are to be filled in by the release author (SUMMARY, DETAILED CHANGELOG).

After merging this PR, a GitHub release (and tag) is created, a wheel is built and tested and on success published to Pypi.

Collection: [Note which collection this PR will affect]

Changelog

  • Add specific line by line info of high level changes in this PR.

Usage

  • You can potentially add a usage example below
# Add a code snippet demonstrating how to use this 

GitHub Actions CI

The Jenkins CI system has been replaced by GitHub Actions self-hosted runners.

The GitHub Actions CI will run automatically when the "Run CICD" label is added to the PR.
To re-run CI remove and add the label again.
To run CI on an untrusted fork, a NeMo user with write access must first click "Approve and run".

Before your PR is "Ready for review"

Pre checks:

  • Make sure you read and followed Contributor guidelines
  • Did you write any new necessary tests?
  • Did you add or update any necessary documentation?
  • Does the PR affect components that are optional to install? (Ex: Numba, Pynini, Apex etc)
    • Reviewer: Does the PR have correct import guards for all optional libraries?

PR Type:

  • New Feature
  • Bugfix
  • Documentation

If you haven't finished some of the above items you can still open "Draft" PR.

Who can review?

Anyone in the community is free to review the PR once the checks have passed.
Contributor guidelines contains specific people who can review PRs to various areas.

Additional Information

  • Related to # (issue)

@github-actions github-actions bot added the CI label Jun 12, 2024
@ko3n1g ko3n1g changed the title Ko3n1g/ci/release ci: Automate release of NeMo Toolkit Jun 12, 2024
@ko3n1g ko3n1g requested review from ericharper and pablo-garay June 12, 2024 12:18
@ko3n1g ko3n1g closed this Jun 13, 2024
@ko3n1g ko3n1g deleted the ko3n1g/ci/release branch June 13, 2024 19:02
@ko3n1g ko3n1g restored the ko3n1g/ci/release branch June 13, 2024 19:19
@ko3n1g ko3n1g reopened this Jun 13, 2024
@ko3n1g ko3n1g force-pushed the ko3n1g/ci/release branch from caaf2c4 to 9fe798b Compare June 25, 2024 10:49
@ko3n1g ko3n1g marked this pull request as ready for review June 25, 2024 10:50
@ko3n1g ko3n1g force-pushed the ko3n1g/ci/release branch from 9fe798b to fb7a670 Compare June 25, 2024 10:50
Copy link
Contributor

This PR is stale because it has been open for 14 days with no activity. Remove stale label or comment or update or this will be closed in 7 days.

@github-actions github-actions bot added the stale label Jul 10, 2024
@ko3n1g ko3n1g force-pushed the ko3n1g/ci/release branch from f363085 to 2f36b8b Compare July 11, 2024 08:58
@ko3n1g ko3n1g force-pushed the ko3n1g/ci/release branch from 2f36b8b to 268c2d7 Compare July 11, 2024 09:03
@ko3n1g ko3n1g closed this Jul 11, 2024
@ko3n1g ko3n1g deleted the ko3n1g/ci/release branch July 11, 2024 09:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant