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

Release PR#3 created workflow for new releases #1584

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from

Conversation

ihsaan-ullah
Copy link
Collaborator

@ihsaan-ullah ihsaan-ullah commented Sep 15, 2024

@ mention of reviewers

@ObadaS

A brief description of the purpose of the changes contained in this PR.

Created a workflow and json file for release information.

Issues this PR resolves

A checklist for hand testing

  • We need to test if with a new release publish, this workflow is triggered

Checklist

  • Code review by me
  • Hand tested by me
  • I'm proud of my work
  • Code review by reviewer
  • Hand tested by reviewer
  • CircleCi tests are passing
  • Ready to merge

@ObadaS
Copy link
Collaborator

ObadaS commented Sep 16, 2024

Looks good on my end, we only need to test it now

  1. I see in the code that you are using >, what do you think about using >> to have a local file in the repo with all the changes ?
  2. The code doesn't specify a branch, does it push the develop or master branch ? I think we want it to push on the master branch, otherwise we would need to do a separate PR to bring the updated file into master after we already merged into master (since we only publish the Release notes once we have successfully merged into master)

The CircleCI test fails with the same error I have on my local machine when trying to deploy the current develop branch. Seems like there is a problem with the Python version used, which could be an easy fix.

@ihsaan-ullah
Copy link
Collaborator Author

Looks good on my end, we only need to test it now

  1. I see in the code that you are using >, what do you think about using >> to have a local file in the repo with all the changes ?

> will rewrite the file while >> will append. I think we want to rewrite the file

  1. The code doesn't specify a branch, does it push the develop or master branch ? I think we want it to push on the master branch, otherwise we would need to do a separate PR to bring the updated file into master after we already merged into master (since we only publish the Release notes once we have successfully merged into master)

I have updated the workflow to push changes to develop branch and automatically create a PR. We should test it on github if this works or not because I have never worked on workflows. I chose develop branch so that everything is consistent and there is no mismatch between develop and master

@ihsaan-ullah ihsaan-ullah changed the title created workflow for new releases Release PR#3 created workflow for new releases Sep 20, 2024
@ihsaan-ullah ihsaan-ullah mentioned this pull request Sep 21, 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.

2 participants