Skip to contentSkip to conversation

2.6 Release announcement

DISCUSSION krtaylor 3 participants 5 messages Feb 15, 2019 – Feb 18, 2019

lore
Share & tools
lore
#1 lore raw

Re: 2.6 Release announcement - doc versioning

Quoted 4 lines · krtaylor

I have not been successful (yet) in trying to get access to our openbmc.org website for adding things like announcements. So, I created a quick release announcement on my personal blog to spread the great news about all the hard work that went into this release!

Thanks Kurt. It looks great!

I got a question from someone who was looking for docs for the 2.6.0 release and for the earlier v2.3 release. They went to the [REST-cheatsheet][] and found guidance which had already been updated for the planned 2.7 release. So they were confused and frustrated because this interface had an incompatible change (to its authentication method). I pointed them into the document history.

Going forward, what is the plan for documentation versioning? We should have a way for someone to get the documentation for a specific release level, for example, to get the docs that apply to the 2.6.0 release. This will become more important as we add new features and make incompatible changes to existing interfaces. Should the openbmc/docs repository have the same branching or tagging as the other openbmc repos? Then someone can just checkout that version.

- Joseph

[REST-cheatsheet]: https://github.com/openbmc/docs/blob/master/REST-cheatsheet.md

...snip...

Quoted 1 line

Kurt Taylor (krtaylor)

author
#2 lore raw

Re: 2.6 Release announcement - doc versioning

Quoted 11 lines · Joseph Reynolds
Quoted 4 lines · krtaylor

I have not been successful (yet) in trying to get access to our openbmc.org website for adding things like announcements. So, I created a quick release announcement on my personal blog to spread the great news about all the hard work that went into this release!

Thanks Kurt.  It looks great!

I got a question from someone who was looking for docs for the 2.6.0 release and for the earlier v2.3 release.  They went to the [REST-cheatsheet][] and found guidance which had already been updated for the planned 2.7 release.  So they were confused and frustrated because this interface had an incompatible change (to its authentication method).  I pointed them into the document history.

Going forward, what is the plan for documentation versioning?  We should have a way for someone to get the documentation for a specific release level, for example, to get the docs that apply to the 2.6.0 release. This will become more important as we add new features and make incompatible changes to existing interfaces.  Should the openbmc/docs repository have the same branching or tagging as the other openbmc repos?  Then someone can just checkout that version.

Yes, understood. And, I like the tagging solution. The only other thing I could think of would be a point-in-time tarball when we tag the release, but that seems much less efficient, and we then have to store those tarballs somewhere.

I'd ping Brad in IRC and see if we can discuss it there.

Kurt Taylor (krtaylor)

#3 lore raw
In reply to krtaylor

Hi Brad, Kurt,

The 2.6.0 tag is a bit weird, that git describe does not correctly get the latest tag:

    $ git describe
    2.6.0-rc1-242-g073a600a0

This results in /etc/os-release to report the build is not from the 2.6.0 tag but from 2.6.0-rc1.

Some investigations:

* Both git describe --tags and git describe --abbrev=0 --tags shows the latest tag is 2.6.0-rc1:

    $ git describe --tags
    2.6.0-rc1-242-g073a600a0
    $ git describe --abbrev=0 --tags
    2.6.0-rc1

* The only way to get the latest tag is with below command:

    $ git describe --tags $(git rev-list --tags --max-count=1)
    2.6.0

* It indicates that the tag 2.6.0 is not on the master branch.

    $ git branch --contains tags/2.6.0
    $ git branch --contains tags/2.6.0-rc1
    * master

Could you help to check and hopefully fix this?

Thanks!

Quoted 12 lines · krtaylor

I have not been successful (yet) in trying to get access to our openbmc.org website for adding things like announcements. So, I created a quick release announcement on my personal blog to spread the great news about all the hard work that went into this release!

http://www.kurttaylor.com/blog/2019/02/openbmc-2-6-release/
or
https://twitter.com/kurtrtaylor/status/1096473964350791681

Kurt Taylor (krtaylor)

#4 lore raw

It turns out that 2.6.0 tag is on thud branch instead of master:

    $ git branch -a --contains tags/2.6.0
      remotes/origin/thud

Hopefully, we could fix this.

Quoted 51 lines · Lei YU

Hi Brad, Kurt,

The 2.6.0 tag is a bit weird, that git describe does not correctly get the latest tag:

    $ git describe
    2.6.0-rc1-242-g073a600a0

This results in /etc/os-release to report the build is not from the 2.6.0 tag but from 2.6.0-rc1.

Some investigations:

* Both git describe --tags and git describe --abbrev=0 --tags shows the latest tag is 2.6.0-rc1:

    $ git describe --tags
    2.6.0-rc1-242-g073a600a0
    $ git describe --abbrev=0 --tags
    2.6.0-rc1

* The only way to get the latest tag is with below command:

    $ git describe --tags $(git rev-list --tags --max-count=1)
    2.6.0

* It indicates that the tag 2.6.0 is not on the master branch.

    $ git branch --contains tags/2.6.0
    $ git branch --contains tags/2.6.0-rc1
    * master

Could you help to check and hopefully fix this?

Thanks!

Quoted 12 lines · krtaylor

I have not been successful (yet) in trying to get access to our openbmc.org website for adding things like announcements. So, I created a quick release announcement on my personal blog to spread the great news about all the hard work that went into this release!

http://www.kurttaylor.com/blog/2019/02/openbmc-2-6-release/
or
https://twitter.com/kurtrtaylor/status/1096473964350791681

Kurt Taylor (krtaylor)