Skip to content

Project: document release process #278

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.

Sign up for GitHub

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

Merged
mrunalp merged 1 commit into from
Dec 23, 2015
Merged

Project: document release process #278

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions project.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Project docs

## Release Process

* Increment version in version.go
Copy link
Contributor

@wking wking Dec 21, 2015

Choose a reason for hiding this comment

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

Does this happen before or after the release? See #203 bumping well before the 0.2.0 release, and my comment in #194 suggesting we either use SemVer's pre-release markers or increase our cadence.

* `git commit` version increment
* `git tag` the prior commit (preferrably signed tag)
* `make docs` to produce PDF and HTML copies of the spec
* Make a release on [github.com/opencontainers/specs](https://github.com/opencontainers/specs/releases) for the version. Attach the produced docs.
Copy link
Contributor

@mrunalp mrunalp Dec 22, 2015

Choose a reason for hiding this comment

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

Move the last sentence to a new line.

Copy link
Member Author

@vbatts vbatts Dec 22, 2015

Choose a reason for hiding this comment

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

it's on a bullet though

Copy link
Contributor

@philips philips Dec 23, 2015

Choose a reason for hiding this comment

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

Yea, disregard the newline thing. Our team actually deprecated the one sentence per-line rule after finding that git log -p --word-diff and github's improved "smart diff" is sufficient: https://github.com/coreos/docs/blob/master/STYLE.md#line-wrapping-considered-harmful