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

Add Github workflow to automate changelog and release pages #486

Merged
merged 3 commits into from
Aug 10, 2023

Conversation

parthosa
Copy link
Collaborator

Fixes #369

The release process within GitHub is automated using a GitHub Actions workflow script.

GitHub Release Workflow:

File - .github/workflow/release.yml

This workflow is triggered when a branch prefixed with 'v*' is pushed. The following steps are executed:

  1. Checkout Code
  2. Create Change Log using a third-party library.
  3. Prepend Current Change Log to CHANGELOG.md in the main branch.
    • Commit and push changes to the main branch.
  4. Create a Release using the output obtained from step 2.

File - .github/workflow/configuration.json

A configuration file to customize the output of change logs.

Library Used - https://github.com/marketplace/actions/release-changelog-builder

@parthosa parthosa self-assigned this Aug 10, 2023
@amahussein amahussein changed the title Enhanced Release Process in GitHub using Workflow Add Github workflow to automate changelog and release pages Aug 10, 2023
Copy link
Collaborator

@amahussein amahussein left a comment

Choose a reason for hiding this comment

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

Thanks Partho!
It will be nice to update the user_tools README file to have a link to the CHANGELOG in the main branch. This is similar to what we have for the user-guide link.

Signed-off-by: Partho Sarthi <[email protected]>
@parthosa
Copy link
Collaborator Author

Thanks Partho!
It will be nice to update the user_tools README file to have a link to the CHANGELOG in the main branch. This is similar to what we have for the user-guide link.

Thanks @amahussein for the review. Updated the README file with link to CHANGELOG in main branch branch.

Copy link
Collaborator

@amahussein amahussein left a comment

Choose a reason for hiding this comment

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

Thanks @parthosa
Just a few minor comments.

user_tools/README.md Outdated Show resolved Hide resolved
user_tools/README.md Outdated Show resolved Hide resolved
Signed-off-by: Partho Sarthi <[email protected]>
Copy link
Collaborator

@amahussein amahussein left a comment

Choose a reason for hiding this comment

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

Great Job @parthosa !

I am fine with PR.

One final issue that @mattahrens can reflect on:
For the upcoming release the changes will be added at the top of an empty changelog. Are you ok with that?
Or do you want to manually pre-populate the changelogs with some of the most recent releases?

@mattahrens
Copy link
Collaborator

It's fine to populate on top of an empty changelog. If needed, we can go back and add in later.

@parthosa parthosa merged commit f31b8e3 into NVIDIA:dev Aug 10, 2023
3 checks passed
@parthosa parthosa deleted the spark-rapids-tools-369 branch August 10, 2023 18:18
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.

[BUG] Github releases page for spark-rapids-tools is outdated
3 participants