Permalink
Browse files

github: new process for release notes

  • Loading branch information...
markus2330 committed Nov 30, 2017
1 parent eeb3fe1 commit 30f3845d3e0925ea768472c8ee7b0af94cabea95
Showing with 159 additions and 44 deletions.
  1. +9 −10 .github/ISSUE_TEMPLATE.md
  2. +3 −2 .github/PULL_REQUEST_TEMPLATE.md
  3. +123 −0 doc/news/_preparation_next_release.md
  4. +23 −5 doc/todo/NEWS.md
  5. +1 −27 doc/todo/ROADMAP.md
View
@@ -1,11 +1,12 @@
Please remove this template if you have
a question or proposal and do not want
to report an issue.
to report a bug.
# Steps to Reproduce the Problem
## Steps to Reproduce the Problem
Please provide a step by step guide on how to reproduce the problem here. If applicable, please use
[Markdown Shell Recorder](https://master.libelektra.org/tests/shell/shell_recorder/tutorial_wrapper) syntax:
Please provide a step by step guide on how to reproduce the problem here. If possible, please use
[Markdown Shell Recorder](https://master.libelektra.org/tests/shell/shell_recorder/tutorial_wrapper)
syntax:
```sh
kdb set /examples/hello world
@@ -22,19 +23,17 @@ kdb get user/does/not/exist
kdb rm /examples/hello
```
.
# Expected Result
## Expected Result
Please describe what should happen if you follow the steps described above.
# Actual Result
## Actual Result
Please describe what actually happened.
# System Information
## System Information
- Elektra Version: master
- Versions of other relevant software?
# Further Log Files and Output
## Further Log Files and Output
@@ -10,10 +10,11 @@ For docu fixes, spell checking and similar nothing
needs to be checked.
- [ ] commit messages are fine (with references to issues)
- [ ] I ran all tests and everything went fine
- [ ] I added unit tests
- [ ] I ran all tests and everything went fine
- [ ] affected documentation is fixed
- [ ] I added code comments, logging, and assertions
- [ ] I added code comments, logging, and assertions (see doc/CODING.md)
- [ ] meta data is updated (e.g. README.md of plugins)
- [ ] release notes are updated (doc/news/_preparation_next_release.md)
@markus2330 please review my pull request
@@ -0,0 +1,123 @@
# 0.8.<<VERSION>> Release
This release did not happen yet.
Please update this file within PRs accordingly.
For non-trivial changes, you can choose to be
part of the highlighted changes. Please make
sure to add some short tutorial or how-to-use
for highlighted items.
Please add your name to every contribution
syntax: ", thanks to <myname>".
<<`scripts/generate-news-entry`>>
We are proud to release Elektra 0.8.<<VERSION>>.
<<`scripts/git-release-stats 0.8.VERSION`>>
## What is Elektra?
Elektra serves as a universal and secure framework to access
configuration settings in a global, hierarchical key database.
For more information, visit [https://libelektra.org](https://libelektra.org).
For a small demo see here:
[![asciicast](https://asciinema.org/a/cantr04assr4jkv8v34uz9b8r.png)](https://asciinema.org/a/cantr04assr4jkv8v34uz9b8r)
## Highlights
- <<HIGHLIGHT1>>
- <<HIGHLIGHT2>>
- <<HIGHLIGHT3>>
### <<HIGHLIGHT1>>
### <<HIGHLIGHT2>>
### <<HIGHLIGHT2>>
## Other New Features
We added even more functionality, which could not make it to the highlights:
- <<TODO>>
## Documentation
We improved the documentation in the following ways:
- <<TODO>>
## Compatibility
As always, the ABI and API of kdb.h is fully compatible, i.e. programs
compiled against an older 0.8 version of Elektra will continue to work
(ABI) and you will be able to recompile programs without errors (API).
## Notes for Maintainer
These notes are of interest for people maintaining packages of Elektra:
- <<TODO>>
## Notes for Elektra's Developers
These notes are of interest for people developing Elektra:
- <<TODO>>
## Fixes
Many problems were resolved with the following fixes:
- <<TODO>>
## Outlook
We are currently working on following topics:
- <<TODO>>
## Get It!
You can download the release from [here](https://www.libelektra.org/ftp/elektra/releases/elektra-0.8.<<VERSION>>.tar.gz)
or [GitHub](https://github.com/ElektraInitiative/ftp/blob/master/releases/elektra-0.8.<<VERSION>>.tar.gz?raw=true)
The [hashsums are:](https://github.com/ElektraInitiative/ftp/blob/master/releases/elektra-0.8.<<VERSION>>.tar.gz.hashsum?raw=true)
<<`scripts/generate-hashsums`>>
The release tarball is also available signed by me using GnuPG from
[here](https://www.libelektra.org/ftp/elektra/releases/elektra-0.8.<<VERSION>>.tar.gz.gpg) or
[GitHub](https://github.com/ElektraInitiative/ftp/blob/master/releases//elektra-0.8.<<VERSION>>.tar.gz.gpg?raw=true)
Already built API-Docu can be found [online](https://doc.libelektra.org/api/0.8.<<VERSION>>/html/)
or [GitHub](https://github.com/ElektraInitiative/doc/tree/master/api/0.8.<<VERSION>>).
## Stay tuned!
Subscribe to the
[RSS feed](https://www.libelektra.org/news/feed.rss)
to always get the release notifications.
For any questions and comments, please contact the
issue tracker [on GitHub](http://issues.libelektra.org)
or me by email using elektra@markus-raab.org.
[Permalink to this NEWS entry](https://doc.libelektra.org/news/0.8.<<VERSION>>-release)
For more information, see [https://libelektra.org](https://libelektra.org)
Best regards,
[Elektra Initiative](https://www.libelektra.org/developers/authors)
View
@@ -1,5 +1,15 @@
# 0.8.<<VERSION>> Release
This release did not happen yet.
Please update this file within PRs accordingly.
For non-trivial changes, you can choose to be
part of the highlighted changes. Please make
sure to add some short tutorial or how-to-use
for highlighted items.
Please add your name to every contribution
syntax: ", thanks to <myname>".
<<`scripts/generate-news-entry`>>
We are proud to release Elektra 0.8.<<VERSION>>.
@@ -19,10 +29,19 @@ For a small demo see here:
## Highlights
- <<HIGHLIGHTS>>
- <<HIGHLIGHT1>>
- <<HIGHLIGHT2>>
- <<HIGHLIGHT3>>
### <<HIGHLIGHT1>>
### <<ONE POINT PER HIGHLIGHT>>
### <<HIGHLIGHT2>>
### <<HIGHLIGHT2>>
## Other New Features
@@ -76,7 +95,7 @@ The [hashsums are:](https://github.com/ElektraInitiative/ftp/blob/master/release
<<`scripts/generate-hashsums`>>
The release tarball is also available signed by me using gpg from
The release tarball is also available signed by me using GnuPG from
[here](https://www.libelektra.org/ftp/elektra/releases/elektra-0.8.<<VERSION>>.tar.gz.gpg) or
[GitHub](https://github.com/ElektraInitiative/ftp/blob/master/releases//elektra-0.8.<<VERSION>>.tar.gz.gpg?raw=true)
@@ -99,7 +118,6 @@ or me by email using elektra@markus-raab.org.
For more information, see [https://libelektra.org](https://libelektra.org)
Best regards,
Markus
[Elektra Initiative](https://www.libelektra.org/developers/authors)
View
@@ -12,13 +12,10 @@ for other activities of the current release.
# 0.8.20
# 0.8.22
## kdb tool
global-umount
kdb set should always validate
(no matter how namespace is given)
@@ -43,27 +40,4 @@ add more traceability
use shell recorder for further README.md
## tests
helper function for searching symbol
## fixes
compiler warnings:
key hash warning
## types
consistent type vs. check/type
different type systems?
let JSON use same types (double, boolean, nothing for string)
type checker plugin redesign: take care of simplicity + working together with others
set of types (min, max as 1-20, enums as user-defined types,...), space separated as now
look into haskell type classes

0 comments on commit 30f3845

Please sign in to comment.