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

Auto generate the change log and releases in CI #249

Merged
merged 17 commits into from
Feb 26, 2021

Conversation

mrbiggred
Copy link
Contributor

@mrbiggred mrbiggred commented Feb 24, 2021

Fixes #241.

Currently the change log and GitHub release are updated every commit. Not sure if this should be changed to only for main branch merges. I also thought about putting the auto-generation of the change log and release in a separate workflow file but then would have to duplicate all the GitVersion steps. If anyone knows of a way to reuse steps in different GitHub Action workflow files let me know.

You can view the Changelog in the branch and the current v0.3.0 GitHub draft release can be found here.

Finally there is an issue where the GitHub release does not format the goals with the auto-generated section. This will hopefully be fixed in v0.12.0 of GitReleaseManager when we can use templates to format the output.

@mrbiggred mrbiggred self-assigned this Feb 24, 2021
@mrbiggred mrbiggred marked this pull request as draft February 24, 2021 16:44
@mrbiggred mrbiggred marked this pull request as ready for review February 25, 2021 16:38
with:
useConfigFile: true
additionalArguments: '/updateprojectfiles'

- name: Display updated csproj File
run: cat Freshli/Freshli.csproj

# Required by GitReleaseManager. Hopefully not for long.
Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder if you could put all this into a separate Github Action job (like eclint, etc.) that would only run on main or on a release branch so we're not building the dotnet-core.yml file to be huge and can run this in parallel.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Haha. I was just updating my initial PR comment with the same thought. The only issue is I would need to duplicate the GitVersion steps, which is not horrible would be nice to avoid. Do you know of a why to reuse steps in different workflow files?

@mrbiggred
Copy link
Contributor Author

I also just realized I didn't update the ReadMe. I'll do that soon the request another review.

@codeclimate
Copy link

codeclimate bot commented Feb 25, 2021

Code Climate has analyzed commit 0d0043d and detected 0 issues on this pull request.

View more on Code Climate.

@mrbiggred
Copy link
Contributor Author

@dfar-io I've moved the release notes logic to it's own file and it seems to work fine. Let me know what you think. We can always change the CI later if something is not working the way we like.

@mrbiggred mrbiggred modified the milestone: v0.3.0 Feb 25, 2021
Copy link
Contributor

@dfar-io dfar-io left a comment

Choose a reason for hiding this comment

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

👍

@mrbiggred mrbiggred merged commit 409990e into main Feb 26, 2021
@mrbiggred mrbiggred deleted the feature-generate-change-log branch February 26, 2021 14:45
@github-actions github-actions bot locked and limited conversation to collaborators Feb 26, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Auto generate change log and GitHub releases
2 participants