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

Added workflow to generate releases #142

Closed
wants to merge 0 commits into from

Conversation

SuperChamp234
Copy link
Member

This PR includes the addition of a github action that will make a github release containing the source code with the Wall-E folder as a zip file, including all submodules.

This PR aims to help cloning the repository during workshops, as an alternative to git clone

Please review.

uses: softprops/[email protected]
with:
files: Wall-E.zip
tag_name: ${{ env.TIMESTAMP }}
Copy link
Member

Choose a reason for hiding this comment

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

Are you sure that we want to use the timestamp for the release?

Copy link
Member Author

Choose a reason for hiding this comment

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

The timestamp variable creates a tag with the year of trigger of the action. Check above for it’s logic.

files: Wall-E.zip
tag_name: ${{ env.TIMESTAMP }}
name: Wall-E Release ${{ env.TIMESTAMP }}
body: This automated release contains the latest Wall-E source code with the submodules. It was triggered by following commit - ${{ github.event.head_commit.id }}
Copy link
Member

Choose a reason for hiding this comment

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

So, this will be triggered after each commit?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes

Copy link
Member

Choose a reason for hiding this comment

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

We don't want it to be released after each commit as possibility of reverting is significant, maybe there should be some trigger word added in the commit to trigger the release

Copy link
Member Author

@SuperChamp234 SuperChamp234 Feb 1, 2024

Choose a reason for hiding this comment

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

We can instead shift to first getting all development commits on the dev branch and keep the main branch only for releases. I can make the changes in the contribution guide for redirecting contributors to merge in the main branch.

Copy link
Member Author

Choose a reason for hiding this comment

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

Or, we can have a separate release branch.

Copy link
Member

Choose a reason for hiding this comment

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

Aah, I think having dev branch is better and then just merge all changes to main

@SuperChamp234
Copy link
Member Author

image

An example release.

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