Prepare RELEASE.md documentation and CHANGELOG.md
This commit is contained in:
parent
7be1754a47
commit
715c4a667b
3
.github_changelog_generator
Normal file
3
.github_changelog_generator
Normal file
@ -0,0 +1,3 @@
|
||||
project=terminator
|
||||
user=gnome-terminator
|
||||
since-tag=1.91
|
2
.gitignore
vendored
2
.gitignore
vendored
@ -16,6 +16,8 @@
|
||||
terminatorc
|
||||
remotinatorc
|
||||
terminatorlib/meliae
|
||||
/dist
|
||||
/MANIFEST
|
||||
|
||||
## language / intltool related files
|
||||
.intltool*
|
||||
|
30
CHANGELOG.md
Normal file
30
CHANGELOG.md
Normal file
@ -0,0 +1,30 @@
|
||||
# Changelog
|
||||
|
||||
## [Unreleased](https://github.com/gnome-terminator/terminator/tree/HEAD)
|
||||
|
||||
[Full Changelog](https://github.com/gnome-terminator/terminator/compare/1.91...HEAD)
|
||||
|
||||
**Implemented enhancements:**
|
||||
|
||||
- Implement support for Python 3 [\#6](https://github.com/gnome-terminator/terminator/pull/6) ([lazyfrosch](https://github.com/lazyfrosch))
|
||||
|
||||
**Fixed bugs:**
|
||||
|
||||
- ctrl+click should open links [\#3](https://github.com/gnome-terminator/terminator/issues/3)
|
||||
- Ensure Python 3 support [\#2](https://github.com/gnome-terminator/terminator/issues/2)
|
||||
- Fix some compat issues for Python 2.7 [\#18](https://github.com/gnome-terminator/terminator/pull/18) ([lazyfrosch](https://github.com/lazyfrosch))
|
||||
- Converting to python 3 and making all tests pass. [\#9](https://github.com/gnome-terminator/terminator/pull/9) ([JAugusto42](https://github.com/JAugusto42))
|
||||
|
||||
**Closed issues:**
|
||||
|
||||
- python3 needs to be in the shebang line for fedora. [\#8](https://github.com/gnome-terminator/terminator/issues/8)
|
||||
|
||||
**Merged pull requests:**
|
||||
|
||||
- Add GitHub action for Python [\#17](https://github.com/gnome-terminator/terminator/pull/17) ([lazyfrosch](https://github.com/lazyfrosch))
|
||||
- Updating URLs in application and appdata [\#16](https://github.com/gnome-terminator/terminator/pull/16) ([mattrose](https://github.com/mattrose))
|
||||
- update the INSTALL file [\#15](https://github.com/gnome-terminator/terminator/pull/15) ([mattrose](https://github.com/mattrose))
|
||||
|
||||
|
||||
|
||||
\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
|
@ -1,7 +1,9 @@
|
||||
include AUTHORS ChangeLog COPYING INSTALL README remotinator setup.py terminator terminator.wrapper run_tests
|
||||
include AUTHORS CHANGELOG* COPYING INSTALL README remotinator setup.py terminator terminator.wrapper run_tests
|
||||
recursive-include data *
|
||||
recursive-include doc *
|
||||
recursive-include po *
|
||||
recursive-include terminatorlib *.py *.glade *.css
|
||||
recursive-include tests *.py
|
||||
|
||||
exclude data/terminator.appdata.xml data/terminator.desktop
|
||||
exclude po/.intltool-merge-cache
|
||||
|
64
RELEASE.md
Normal file
64
RELEASE.md
Normal file
@ -0,0 +1,64 @@
|
||||
Releasing Terminator
|
||||
====================
|
||||
|
||||
Make sure you have the latest master branch, no un-committed changes, and are ready to release that state.
|
||||
|
||||
```
|
||||
VERSION=1.92
|
||||
```
|
||||
|
||||
## Set version in Python
|
||||
|
||||
```
|
||||
sed -i "s/APP_VERSION =.*/APP_VERSION = '${VERSION}'/" terminatorlib/version.py
|
||||
```
|
||||
|
||||
## Generate the changelog
|
||||
|
||||
For the changelog we are using [github-changelog-generator](https://github.com/github-changelog-generator/github-changelog-generator)
|
||||
|
||||
```
|
||||
github_changelog_generator --future-release "$VERSION"
|
||||
```
|
||||
|
||||
Check and review CHANGELOG.md for the expected result.
|
||||
|
||||
## Git Tag
|
||||
|
||||
Commit these changes to the "master" branch:
|
||||
|
||||
```
|
||||
git add terminatorlib/version.py CHANGELOG.md RELEASE.md
|
||||
git commit -v -m "Release version $VERSION"
|
||||
git push origin master
|
||||
```
|
||||
|
||||
And tag it with a signed tag:
|
||||
|
||||
```
|
||||
git tag -s -m "Version $VERSION" v$VERSION
|
||||
```
|
||||
|
||||
Push the tag.
|
||||
|
||||
```
|
||||
git push --tags
|
||||
```
|
||||
|
||||
## Signed artifacts
|
||||
|
||||
To provide a signed tarball for distributions we use sdist and gpg:
|
||||
|
||||
```
|
||||
python setup.py sdist
|
||||
gpg -u markus@lazyfrosch.de --armor \
|
||||
--output dist/terminator-${VERSION}.tar.gz.asc \
|
||||
--detach-sig dist/terminator-${VERSION}.tar.gz
|
||||
```
|
||||
|
||||
## GitHub Release
|
||||
|
||||
Now update the tag to a release on GitHub, and add the artifacts:
|
||||
https://github.com/gnome-terminator/terminator/releases
|
||||
|
||||
Make sure to add the proper section from CHANGELOG.md as description to the release.
|
41
RELEASING
41
RELEASING
@ -1,41 +0,0 @@
|
||||
Here are the steps to follow to create a new terminator release:
|
||||
|
||||
1. Ensure there are no local, uncommitted/unpushed modifications.
|
||||
|
||||
$ bzr status
|
||||
|
||||
2. Verify the code passes checks and tests
|
||||
|
||||
$ python setup.py test
|
||||
$ python setup.py check
|
||||
|
||||
3. Update version number. Edit terminatorlib/version.py and set the
|
||||
version number. Also edit terminator.spec and set it there. Edit
|
||||
the debian/changelog to add new version. Update the Changelog
|
||||
file if not already up-to-date.
|
||||
|
||||
4. Create the source distribution package
|
||||
|
||||
$ python setup.py sdist
|
||||
|
||||
5. Sign the tarball
|
||||
|
||||
$ gpg -u bryce@bryceharrington.org --armor --output
|
||||
terminator-0.98.tar.gz.asc --detach-sig terminator-0.98.tar.gz
|
||||
|
||||
6. Upload to Launchpad
|
||||
|
||||
+ Create the appropriate Milestone
|
||||
+ Create a matching Release
|
||||
+ Upload the tarball and gpg signature to the Release
|
||||
|
||||
7. Tag the release in trunk
|
||||
|
||||
$ bzr tag 0.98
|
||||
$ bzr push
|
||||
|
||||
8. Post announcements
|
||||
|
||||
+ Write a blog post
|
||||
+ Create an Announcement on the Launchpad page.
|
||||
Include a link to the blog post URL
|
Loading…
Reference in New Issue
Block a user