From 715c4a667bf7da0d0fc7719568269505d9d8ddcf Mon Sep 17 00:00:00 2001 From: Markus Frosch Date: Fri, 17 Apr 2020 19:12:57 +0200 Subject: [PATCH] Prepare RELEASE.md documentation and CHANGELOG.md --- .github_changelog_generator | 3 ++ .gitignore | 2 + ChangeLog => CHANGELOG.legacy.txt | 0 CHANGELOG.md | 30 +++++++++++++++ MANIFEST.in | 4 +- RELEASE.md | 64 +++++++++++++++++++++++++++++++ RELEASING | 41 -------------------- 7 files changed, 102 insertions(+), 42 deletions(-) create mode 100644 .github_changelog_generator rename ChangeLog => CHANGELOG.legacy.txt (100%) create mode 100644 CHANGELOG.md create mode 100644 RELEASE.md delete mode 100644 RELEASING diff --git a/.github_changelog_generator b/.github_changelog_generator new file mode 100644 index 00000000..1c66fb96 --- /dev/null +++ b/.github_changelog_generator @@ -0,0 +1,3 @@ +project=terminator +user=gnome-terminator +since-tag=1.91 diff --git a/.gitignore b/.gitignore index 535678d7..7f74dcdf 100644 --- a/.gitignore +++ b/.gitignore @@ -16,6 +16,8 @@ terminatorc remotinatorc terminatorlib/meliae +/dist +/MANIFEST ## language / intltool related files .intltool* diff --git a/ChangeLog b/CHANGELOG.legacy.txt similarity index 100% rename from ChangeLog rename to CHANGELOG.legacy.txt diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..5de543d9 --- /dev/null +++ b/CHANGELOG.md @@ -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)* diff --git a/MANIFEST.in b/MANIFEST.in index fb593e54..89f36fab 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -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 diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 00000000..6b313933 --- /dev/null +++ b/RELEASE.md @@ -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. diff --git a/RELEASING b/RELEASING deleted file mode 100644 index d8b9f38c..00000000 --- a/RELEASING +++ /dev/null @@ -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