public-Repo-Mirrors/Top-Bar-Organizer
1
Fork 0
mirror of https://gitlab.gnome.org/julianschacher/top-bar-organizer.git synced 2025-10-27 07:09:07 +00:00
Code Releases Activity

docs: exp. docs on creat. a new tag to cover how to create a new release

Browse Source 
Also generally fix up the docs and the git_annotated_tag_template a bit,
make the tag template not include the shortlog anymore (as that doesn't
make that much sense) and also provide a release_notes_template.md.
This commit is contained in:
June 2024-09-11 03:37:37 +02:00
parent 1870a9510a
commit 8fb92d1bb1
No known key found for this signature in database
4 changed files with 67 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
docs/Creating_a_New_Release.md Normal file
View File

@ -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.

22
docs/Creating_a_New_Tag.md
View File

@ -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 <tagname> [<commit>]
```
3. Restore `git_annotated_tag_template` to its original state:
```
git restore git_annotated_tag_template
```
4. Push the new tag.
```
git push --tags
```

15
docs/release_notes_template.md Normal file
View File

@ -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:
<list relevant and/or breaking changes of this version here>
# `git shortlog`
The git shortlog for this version:
```
<paste the git shortlog for this version here>
```

8
git_annotated_tag_template
View File

@ -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:
<list relevant and/or breaking changes of this version here>
# `git shortlog`
The git shortlog for this version:
<paste the git shortlog for this version here>