Skip to content

feat: Add PyPI release workflow#44

Merged
bmtcril merged 2 commits intomainfrom
farhaan/workflow-release
Jan 7, 2026
Merged

feat: Add PyPI release workflow#44
bmtcril merged 2 commits intomainfrom
farhaan/workflow-release

Conversation

@farhaanbukhsh
Copy link
Member

@farhaanbukhsh farhaanbukhsh commented Dec 17, 2025

Description

Adds the workflow for PyPI release of the tutor-contrib-platform-notifications, this workflow helps to tag and publish this repo.

Useful information to include:

  • We need to create GitHub token and set it in secrets
  • We need to add PyPI token to the secrets

Testing instructions

No way to test this as of now this is taken from https://github.com/openedx/tutor-contrib-aspects/blob/main/.github/workflows/release.yaml

Private Ref: https://tasks.opencraft.com/browse/BB-10380

Signed-off-by: Farhaan Bukhsh <farhaan@opencraft.com>
@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Dec 17, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Dec 17, 2025

Thanks for the pull request, @farhaanbukhsh!

This repository is currently maintained by @openedx/committers-tutor-contrib-platform-notifications.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@mphilbrick211 mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions Dec 19, 2025

jobs:
release:
if: github.event.pull_request.merged == true && startsWith(github.head_ref, 'bot/v')
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think this is what we want, there aren't any bot PRs in this repo are there? I'd expect the trigger above to be something like so that when we roll a release in GitHub it publishes to PyPI:

on:
  release:
    types: [published]

Copy link
Member Author

Choose a reason for hiding this comment

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

@bmtcril fixed :)

Base automatically changed from bmtcril/project_rename to main January 6, 2026 14:30
@bmtcril bmtcril merged commit ce7fae3 into main Jan 7, 2026
3 checks passed
@bmtcril bmtcril deleted the farhaan/workflow-release branch January 7, 2026 14:20
@github-project-automation github-project-automation bot moved this from In Eng Review to Done in Contributions Jan 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

4 participants