diff --git a/docs/Creating_a_New_Release.md b/docs/Creating_a_New_Release.md new file mode 100644 index 0000000..38d7980 --- /dev/null +++ b/docs/Creating_a_New_Release.md @@ -0,0 +1,51 @@ +# Creating a Release + +## Create a Tag + +To create a new tag, do the following: + +1. Fill out `git_annotated_tag_template`. +2. Run the following command to tag the current commit with `vX`: + + ``` + git tag -a -F git_annotated_tag_template -s --cleanup=verbatim vX + ``` + +3. Restore `git_annotated_tag_template` to its original state: + + ``` + git restore git_annotated_tag_template + ``` + +4. Push the tag: + + ``` + git push --tags + ``` + +## Build a Release-ZIP + +1. Build the release-ZIP: + + ``` + ./package.sh + ``` + +2. Name the release-ZIP after the current version: + + ``` + mv top-bar-organizer@julian.gse.jsts.xyz.shell-extension.zip top-bar-organizer@julian.gse.jsts.xyz.shell-extension_vX.zip + ``` + +## Create a GitLab Release + +1. Go to the [Releases section of the repo](https://gitlab.gnome.org/june/top-bar-organizer/-/releases) and click on the "New Release" button. +2. Select the corresponding tag created earlier. +3. Name the release "Top Bar Organizer vX". +4. Copy the [release notes template](./release_notes_template.md) and fill it out. +5. Upload the release-ZIP created in the previous step as a release asset. +6. Create the release. + +## Uploading to the GNOME Extensions Website + +1. Go to the [upload page of the GNOME extensions website](https://extensions.gnome.org/upload/) and upload the release-ZIP. diff --git a/docs/Creating_a_New_Tag.md b/docs/Creating_a_New_Tag.md deleted file mode 100644 index 9cfb87d..0000000 --- a/docs/Creating_a_New_Tag.md +++ /dev/null @@ -1,22 +0,0 @@ -# Creating a New Tag - -To create a new tag, do the following: - -1. Fill out `git_annotated_tag_template`. -2. Run the following command: - - ``` - git tag -a -F git_annotated_tag_template -s --cleanup=verbatim [] - ``` - -3. Restore `git_annotated_tag_template` to its original state: - - ``` - git restore git_annotated_tag_template - ``` - -4. Push the new tag. - - ``` - git push --tags - ``` diff --git a/docs/release_notes_template.md b/docs/release_notes_template.md new file mode 100644 index 0000000..740ef00 --- /dev/null +++ b/docs/release_notes_template.md @@ -0,0 +1,15 @@ +Top Bar Organizer vX includes the following changes: + +# Relevant and/or Breaking Changes + +The following relevant and/or breaking changes of this version: + + + +# `git shortlog` + +The git shortlog for this version: + +``` + +``` diff --git a/git_annotated_tag_template b/git_annotated_tag_template index 7ad6f78..5f9a5c0 100644 --- a/git_annotated_tag_template +++ b/git_annotated_tag_template @@ -1,13 +1,7 @@ -Top Bar Organizer v1 includes the following changes: +Top Bar Organizer vX includes the following changes: # Relevant and/or Breaking Changes The following relevant and/or breaking changes of this version: - -# `git shortlog` - -The git shortlog for this version: - -