Skip to content

Commit

Permalink
Add version code name
Browse files Browse the repository at this point in the history
Krekeler committed Dec 18, 2018

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
1 parent e82347d commit 78dcab7
Showing 5 changed files with 28 additions and 21 deletions.
38 changes: 20 additions & 18 deletions doc/release-process.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,23 @@
TODO : Release Process
DMS Release Process
====================

* Update translations, see [translation_process.md](https://github.com/Krekeler/documentchain/blob/master/doc/translation_process.md#synchronising-translations).
* (Update translations, see [translation_process.md](https://github.com/Krekeler/documentchain/blob/master/doc/translation_process.md#synchronising-translations).)

* Update manpages, see [gen-manpages.sh](https://github.com/Krekeler/documentchain/blob/master/contrib/devtools/README.md#gen-manpagessh).
* (Update manpages, see [gen-manpages.sh](https://github.com/Krekeler/documentchain/blob/master/contrib/devtools/README.md#gen-manpagessh).)

Before every minor and major release:

* Update [bips.md](bips.md) to account for changes since the last release.
* (Update [bips.md](bips.md) to account for changes since the last release.)
* Update version in sources (see below)
* Write release notes (see below)
* Update `src/chainparams.cpp` nMinimumChainWork with information from the getblockchaininfo rpc.
* Update `src/chainparams.cpp` defaultAssumeValid with information from the getblockhash rpc.
- The selected value must not be orphaned so it may be useful to set the value two blocks back from the tip.
- Testnet should be set some tens of thousands back from the tip due to reorgs there.
- This update should be reviewed with a reindex-chainstate with assumevalid=0 to catch any defect
that causes rejection of blocks in the past history.

Before every major release:

* Update hardcoded [seeds](/contrib/seeds/README.md). TODO: Give example PR for Dash
* Update `src/chainparams.cpp`
- nMinimumChainWork with information from the getblockchaininfo rpc.
- Add checkpointData
- Set defaultAssumeValid to latest checkpoint (with information from the getblockhash rpc).
The selected value must not be orphaned so it may be useful to set the value two blocks back from the tip.
Testnet should be set some tens of thousands back from the tip due to reorgs there.
This update should be reviewed with a reindex-chainstate with assumevalid=0 to catch any defect that causes rejection of blocks in the past history.
* Update hardcoded [seeds](/contrib/seeds/README.md) with stable Masternodes.
* Update [`BLOCK_CHAIN_SIZE`](/src/qt/intro.cpp) to the current size plus some overhead.

### First time / New builders
@@ -34,21 +32,25 @@ Check out the source code in the following directory hierarchy.
git clone https://github.com/devrandom/gitian-builder.git
git clone https://github.com/Krekeler/documentchain.git

### DMS Core maintainers/release engineers, update (commit) version in sources
### Update version in sources and write release notes

Client version

- `configure.ac`:
- `_CLIENT_VERSION_MAJOR`
- `_CLIENT_VERSION_MINOR`
- `_CLIENT_VERSION_REVISION`
- Don't forget to set `_CLIENT_VERSION_IS_RELEASE` to `true`
- Set `_CLIENT_VERSION_IS_RELEASE` to `true`
- `src/clientversion.h`: (this mirrors `configure.ac` - see issue #3539)
- `CLIENT_VERSION_MAJOR`
- `CLIENT_VERSION_MINOR`
- `CLIENT_VERSION_REVISION`
- Don't forget to set `CLIENT_VERSION_IS_RELEASE` to `true`
- Set `CLIENT_VERSION_IS_RELEASE` to `true`
- `COPYRIGHT_YEAR`
- `RELEASE_CODE_NAME` **A**lice, **B**ob, **C**arol etc.
- `doc/README.md` and `doc/README_windows.txt`
- `doc/Doxyfile`: `PROJECT_NUMBER` contains the full version
- `contrib/gitian-descriptors/*.yml`: usually one'd want to do this on master after branching off the release - but be sure to at least do it before a new major release
- `contrib/gitian-descriptors/*.yml`: documentchain-win-0.12

Write release notes. git shortlog helps a lot, for example:

3 changes: 3 additions & 0 deletions src/clientversion.h
Original file line number Diff line number Diff line change
@@ -32,6 +32,9 @@

#endif //HAVE_CONFIG_H

// Release code names: Alice 0.12.9, Bob 0.12.10, Carol 0.12.11
#define RELEASE_CODE_NAME "Carol"

/**
* Converts the parameter X to a string after macro replacement on X has been performed.
* Don't merge these into one macro!
2 changes: 2 additions & 0 deletions src/qt/bitcoingui.cpp
Original file line number Diff line number Diff line change
@@ -13,6 +13,7 @@

#include "bitcoinunits.h"
#include "clientmodel.h"
#include "clientversion.h"
#include "guiconstants.h"
#include "guiutil.h"
#include "modaloverlay.h"
@@ -146,6 +147,7 @@ BitcoinGUI::BitcoinGUI(const PlatformStyle *_platformStyle, const NetworkStyle *
} else {
windowTitle += tr("Node");
}
windowTitle += " \"" RELEASE_CODE_NAME "\"";
QString userWindowTitle = QString::fromStdString(GetArg("-windowtitle", ""));
if(!userWindowTitle.isEmpty()) windowTitle += " - " + userWindowTitle;
windowTitle += " " + networkStyle->getTitleAddText();
2 changes: 1 addition & 1 deletion src/qt/splashscreen.cpp
Original file line number Diff line number Diff line change
@@ -49,7 +49,7 @@ SplashScreen::SplashScreen(Qt::WindowFlags f, const NetworkStyle *networkStyle)

// define text to place
QString titleText = tr(PACKAGE_NAME);
QString versionText = QString(tr("Version %1")).arg(QString::fromStdString(FormatFullVersion()));
QString versionText = QString(tr("Version %1")).arg(QString::fromStdString(FormatFullVersion()) + " \"" + RELEASE_CODE_NAME + "\"");
QString copyrightText = QString::fromUtf8(CopyrightHolders("\xc2\xA9", 2014, COPYRIGHT_YEAR).c_str());
QString titleAddText = networkStyle->getTitleAddText();
// networkstyle.cpp can't (yet) read themes, so we do it here to get the correct Splash-screen
4 changes: 2 additions & 2 deletions src/qt/utilitydialog.cpp
Original file line number Diff line number Diff line change
@@ -52,7 +52,7 @@ HelpMessageDialog::HelpMessageDialog(QWidget *parent, HelpMode helpMode) :

if (helpMode == about)
{
setWindowTitle(tr("About %1").arg(tr(PACKAGE_NAME)));
setWindowTitle(tr("About %1").arg(tr(PACKAGE_NAME)) + " \"" + RELEASE_CODE_NAME + "\"");

/// HTML-format the license message from the core
QString licenseInfo = QString::fromStdString(LicenseInfo());
@@ -68,7 +68,7 @@ HelpMessageDialog::HelpMessageDialog(QWidget *parent, HelpMode helpMode) :
ui->aboutMessage->setTextFormat(Qt::RichText);
ui->scrollArea->setVerticalScrollBarPolicy(Qt::ScrollBarAsNeeded);
text = version + "\n" + licenseInfo;
ui->aboutMessage->setText(version + "<br><br>" + licenseInfoHTML);
ui->aboutMessage->setText(version + ", code name \"" + RELEASE_CODE_NAME + "\"<br><br>" + licenseInfoHTML);
ui->aboutMessage->setWordWrap(true);
ui->helpMessage->setVisible(false);
} else if (helpMode == cmdline) {

0 comments on commit 78dcab7

Please sign in to comment.