Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Releases: Variablize Release Notes #764

Closed
wants to merge 2 commits into
from

Conversation

Projects
None yet
2 participants
Contributor

harding commented Feb 23, 2015

HTML site diff (English only): http://dg2.dtrt.org/diff.html

This is a re-do of pull #751 that only implements the parts @saivann and I could both agree on per this comment.

It adds additional variables to the release note files to allow setting the version number and date. The version number is required, and can be used to automatically set the release notes title. The date is optional and can be set hours/days after the release.

Additionally, a Makefile test is added that checks whether the download files exist on the Bitcoin.org server. This can help prevent creating a broken Download page.

Changes in commit 404af8b

  • Set variables for all previous releases
  • Document variables in README.md
  • Update code and templates to use variables
  • Add the Download page links to the "dl" CSS class. Also add newlines to make the HTML a bit easier to parse using sed
  • Add a new Liquid plugin to print warnings. This is used to print a non-error warning if any release is created without the optional date

Changes in commit b88f6ee

  • Renamed the old release files:

    cd _releases
    rename 's/^.*-v//' *
    git add *
    

harding added some commits Feb 23, 2015

Releases: Variablize Release Notes
Add additional variables to the release note files to allow setting the
version number and date.  The version number is required, and can be
used to automatically set the release notes title.  The date is optional
and can be set hours/days after the release.

Additionally, a Makefile test is added that checks whether the download
files exist on the Bitcoin.org server.  This can help prevent creating a
broken Download page.

* Set variables for all previous releases

* Document variables in README.md

* Update code and templates to use variables

* Add the Download page links to the "dl" CSS class. Also add newlines
  to make the HTML a bit easier to parse using sed

* Add a new Liquid plugin to print warnings. This is used to print a
  non-error warning if any release is created without the optional date
Releases: Rename Release Files
    cd _releases
    rename 's/^.*-v//' *
    git add *

@saivann saivann commented on the diff Feb 24, 2015

README.md
-...
-```
-* `VERSION` is used to define the version and construct the URL. It should adhere to this format: `v0.3.24`.
-* `title: ...` will be used as the title.
-* `magnetlink: ...` (optional) the urlencoded torrent magnet link on the download page.
+Download links will automatical be set to the defaults using the current
@saivann

saivann Feb 24, 2015

Contributor

@harding s/automatical/automatically/

Contributor

saivann commented Feb 24, 2015

@harding LGTM! I've quickly tested the result and reviewed the code.

Contributor

harding commented Feb 24, 2015

@saivann thanks! (I'll fix that typo.)

In the absence of critical feedback, this will be merged around 01:00 UTC Friday.

harding added a commit that referenced this pull request Feb 27, 2015

Contributor

harding commented Feb 27, 2015

Had to rebase to fix Makefile conflict with #776, so merged as 18defab

@harding harding closed this Feb 27, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment