-
-
Notifications
You must be signed in to change notification settings - Fork 279
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
chore(main): release 1.0.0 #1215
chore(main): release 1.0.0 #1215
Conversation
@jay-babu 👋 figured I'd ask you since I couldn't find anything in their docs yet. How does one change the CHANGELOG of the release? Do I simply edit the body and then merge? |
Once the release is made, you can edit the notes. At least that's how I have done it |
6eba28a
to
e14ff80
Compare
@williamboman did that make sense or no? |
Yeah! I think I'll manually cut the 1.0.0 release and delegate the rest to CI |
e6dd2a2
to
d4171f1
Compare
d4171f1
to
61e4743
Compare
With respect to release creation, the Github CLI tool gh release create v${VERSION}r${RELEASE} ${DRAFT} \
--title "${ANNO}" \
--notes-file ReleaseNotes.md \
lazyman.sh where VERSION and RELEASE are something like 1.0.0 and 1, ANNO is the annotation for the tag, and DRAFT is the draft flag (empty or --draft). Note the The final argument above, Prior to running gh a tag for the release was created with: git tag -a "v${VERSION}r${RELEASE}" -m " ${ANNO}"
git push origin "v${VERSION}r${RELEASE}" and after gh is run the new tag is fetched. Perhaps CI can handle your release needs perfectly well. I am just providing this in case you wish to automate release creation from the command line. Here is my full #!/bin/bash
[ -f VERSION ] || {
echo "VERSION file missing. Exiting."
exit 1
}
. ./VERSION
usage() {
printf "\nUsage: mkrelease [-d] [-u]"
printf "\nWhere:"
printf "\n\t-d indicates create draft release"
printf "\n\t-u displays this usage message and exits\n"
exit 1
}
DRAFT=
while getopts "du" flag; do
case $flag in
d)
DRAFT="--draft"
;;
u)
usage
;;
esac
done
shift $(( OPTIND - 1 ))
ANNO="Lazyman Version ${VERSION} Release ${RELEASE}"
gittag v${VERSION}r${RELEASE} ${ANNO}
echo "Creating release for version ${VERSION} release ${RELEASE}"
gh release create v${VERSION}r${RELEASE} ${DRAFT} \
--title "${ANNO}" \
--notes-file ReleaseNotes.md \
lazyman.sh
git fetch --tags origin
|
Thanks @doctorfree! The primary reason I think this particular GitHub action is helpful is because it 1) helps with the procurement of the changelog/release notes based on (conventional) commit history, 2) keeps track of what kind of release to make based on the commit history. |
I wonder what happens if I close this. I'll manually cut the initial 1.0.0 release anyways. |
🤖 I have created a release beep boop
1.0.0 (2023-04-19)
Features
Bug Fixes
This PR was generated with Release Please. See documentation.