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

Adds release notes generation script #359

Merged
merged 2 commits into from
Aug 30, 2021
Merged

Conversation

codefromthecrypt
Copy link
Contributor

This will be used in the new release process to generate draft release
notes that a person edits before clicking publish.

Notably, this correctly annotates co-authors, which is a common practice
in func-e, but easy to miss.

Ex. (nevermind the 'aster' as I'm hacking this to show pending notes)

$ .github/workflows/release_notes.sh master


func-e aster supports X and Y and notably fixes Z

TODO: classify the below into up to 4 major headings and the rest as bulleted items in minor changes
The published release notes should only include the summary statement in this section.

ee700a1 Converts e2e to new Makefile (#356) Adrian Cole, Co-authored-by: Dhi Aurrahman [email protected]

83e7c30 updates last known Envoy to 1.19.1 (#355) Adrian Cole,
f975609 Aligns make to func-e color scheme (#354) Adrian Cole,
551840f Scaffold a new Makefile (#353) Adrian Cole,
877a72e Removes bingo for go run (#350) Adrian Cole, Co-authored-by: Takeshi Yoneda [email protected]

12a74b1 Adds vanity downloads (#351) Adrian Cole,
0f313c8 Pares down code to work around flake (#349) Adrian Cole,
e74c0b7 Removes test utilities for built-ins (#347) Adrian Cole,
41c2742 Cleans up tests (#348) Adrian Cole,
17375b4 Updates to Go 1.17 (#346) Adrian Cole,
6ae5d48 Corrects manifest path Adrian Cole,
a9ccc4d fixes auth Adrian Cole,
a4bc290 Fixes glitches in package update script (#344) Adrian Cole,

X packages

Don't forget to cite who was involved and why

func-e Y

Minor changes

TODO: don't add trivial things like fixing spaces or non-concerns like build glitches

  • Z is now fixed thanks to Yogi Bear

Thank you

func-e aster was possible thanks to the following contributors:

Adrian Cole
Dhi Aurrahman
Takeshi Yoneda

This will be used in the new release process to generate draft release
notes that a person edits before clicking publish.

Notably, this correctly annotates co-authors, which is a common practice
in func-e, but easy to miss.
@@ -0,0 +1,41 @@
#!/bin/sh -ue
Copy link
Collaborator

Choose a reason for hiding this comment

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

I can see that we don't always use bash.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I never use bash in release scripts as was formerly bit by doing things in docker with alpine. It is easier to never use it, as normal syntax is always around.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

basically you'll notice in scripts and also make, main dependencies will be sed, awk etc. even being really conservative things like windows translations bite.. we do what we can 😅

Signed-off-by: Adrian Cole <[email protected]>
@codefromthecrypt
Copy link
Contributor Author

e2e tests are failing on centos for an unrelated reason

@codefromthecrypt codefromthecrypt merged commit e181b4d into master Aug 30, 2021
@codefromthecrypt codefromthecrypt deleted the gen-release-notes branch August 30, 2021 03:39
@codefromthecrypt
Copy link
Contributor Author

I'll watch to see if the action glitches are persistent as maybe we get lucky

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.

3 participants