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 a make command to generate release notes #433

Merged
merged 2 commits into from
Oct 31, 2024
Merged

Add a make command to generate release notes #433

merged 2 commits into from
Oct 31, 2024

Conversation

tas50
Copy link
Member

@tas50 tas50 commented Oct 30, 2024

Description

I was wasting time copying the last one each time and then changing things to make it a template that I could use for the next week. Why not automate this a bit?

Related issue

Types of changes

  • Functional documentation bug fix (i.e., broken link or some other busted behavior)
  • New functional doc capabilities (i.e., filter search results)
  • New content
  • Revision to existing content
  • Chore (non-breaking change that does not add functionality or fix an issue)

Checklist

  • I have read the README document about contributing to this repo.
  • I have tested my changes locally and there are no issues.
  • All commits are signed.

Copy link
Contributor

Starting creation of the PREview environment...

Copy link
Contributor

PREview environment has been created at https://mondoo-pre-docs-3005900428.storage.googleapis.com/docs/index.html
Please allow a few minutes for the environment to be fully deployed.

This comment has been minimized.

This comment has been minimized.

Copy link
Contributor

@tas50 tas50 force-pushed the tas50/notes_make branch 2 times, most recently from 382333d to b91b686 Compare October 30, 2024 21:12

This comment has been minimized.

This comment has been minimized.

I was wasting time copying the last one each time and then changing
things to make it a template that I could use for the next week. Why not
automate this a bit?

Signed-off-by: Tim Smith <tsmith84@gmail.com>
Copy link
Contributor

2 similar comments
Copy link
Contributor

Copy link
Contributor

Copy link

@afiune afiune left a comment

Choose a reason for hiding this comment

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

Is this just a template? or, where are you generating the release notes? 🤔

At my previous employer, I created this simple bash script that generates the release notes based of our CLEAN git history, not sure if we want to do something similar?

https://github.com/lacework/go-sdk/blob/main/scripts/release.sh#L254

Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Signed-off-by: Tim Smith <tsmith84@gmail.com>
Copy link
Contributor

@tas50 tas50 merged commit d10a22d into main Oct 31, 2024
8 checks passed
@tas50 tas50 deleted the tas50/notes_make branch October 31, 2024 16:17
Copy link
Contributor

Cleaning up PREview environment...

@tas50
Copy link
Member Author

tas50 commented Oct 31, 2024

@afiune the release notes are marketing things mostly not a technical description of what ships so git commits don't really work. I always start by checking all the releases and obviously the better folks write their commits, the easier it is on me, but it would be pretty hard to automate at that level. It needs a human touch.

@github-actions github-actions bot locked and limited conversation to collaborators Oct 31, 2024
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.

3 participants