Skip to content
New issue

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

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare the readme intro and changelog for 1.0.0-beta1 #174

Merged
merged 9 commits into from
Nov 7, 2018

Conversation

webmat
Copy link
Contributor

@webmat webmat commented Nov 6, 2018

Preparing the beta1 release.

This PR includes:

  • Tweaks to the warning at the very top of the readme
  • Introduction of a "Versions" section in the readme intro, with a link to past releases, as well as a warning that the master branch is not the spec.
  • Added 1.0.0-beta1 section below a now empty "Unreleased" section in the changelog
  • Added a formal 0.1.0 section at the bottom of the changelog

Closes #167

@webmat webmat self-assigned this Nov 6, 2018
@webmat webmat mentioned this pull request Nov 6, 2018
26 tasks
CHANGELOG.md Outdated
are not in agreement, the README.md should be considered the official spec.
The other two files are simply provided as a convenience, and are not yet
fully up to date.
* Two field sets have been temporarily removed from 1.0.0-beta.1. They will be
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's not make any promises in release notes. Remove this part.

CHANGELOG.md Outdated
All notable changes to this project will be documented in this file based on the [Keep a Changelog](http://keepachangelog.com/) Standard. This project adheres to [Semantic Versioning](http://semver.org/).

## [1.0.0-beta.1](https://github.com/elastic/ecs/tag/v1.0.0-beta.1) - 2018-11-08
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would keep a section on top with #Unreleased and all the headers inside. The release part is then copied into the release notes on Github.

CHANGELOG.md Outdated
## [Unreleased](https://github.com/elastic/ecs/compare/0.1.0...master)
### Caveats with this release

* When the README.md file and other generated files (schema.csv and template.json)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets' move this into the readme.

@webmat webmat changed the title Change readme intro and changelog for 1.0.0-beta.1 Prepare the readme intro and changelog for 1.0.0-beta1 Nov 7, 2018
@webmat webmat merged commit 7933a0d into elastic:master Nov 7, 2018
@webmat webmat deleted the releaseme branch November 7, 2018 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants