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

Update release doc with some notes from 0.8.0 process #567

Merged
merged 6 commits into from
Apr 13, 2020

Conversation

dsherry
Copy link
Contributor

@dsherry dsherry commented Apr 1, 2020

No description provided.

@dsherry dsherry added documentation Improvements or additions to documentation enhancement An improvement to an existing feature. labels Apr 1, 2020
@dsherry dsherry self-assigned this Apr 1, 2020
release.md Outdated

Make the following changes in the release PR:
* Update `setup.py` and `evalml/__init__.py` to bump `__version__` to the new version.
* Reformat the changelog to github markdown. This is currently done by hand and can be done faster with some clever text editor features.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this done so that it looks better on GitHub?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yeah

@codecov
Copy link

codecov bot commented Apr 1, 2020

Codecov Report

Merging #567 into master will not change coverage by %.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #567   +/-   ##
=======================================
  Coverage   98.96%   98.96%           
=======================================
  Files         133      133           
  Lines        4545     4545           
=======================================
  Hits         4498     4498           
  Misses         47       47           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f28b876...c572d22. Read the comment docs.

release.md Outdated
* Find "vX.X.X" in the version list, and click "Edit" on the right.
* Check the "Active" checkbox and set privacy level to "Public", then click "Save"

Readthedocs will now a) list "vX.X.X" as a viewable branch of our public documentation, and b) update the default "stable" branch to point to the new documentation. Please verify that both of these things are true before proceeding.
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think we need to update the "stable" branch since RTD points to the latest release as stable.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

right, i'm just describing what readthedocs does for us when we activate the branch. is this inaccurate?

Copy link
Contributor

Choose a reason for hiding this comment

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

yeah! sorry I wasn't english-ing lol

Copy link
Contributor

Choose a reason for hiding this comment

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

In line 40 it sounds as if RTD waits to update stable to the latest tag until the new "v.X.X.X" branch is active and public, but is that actually what happens?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@rwedge good question. I see in the readthedocs doc that they rely on us to create tags in our repo for each release which conform to semantic versioning. Whenever a new tag is published which is higher than the others (like 0.8.0 just did), that becomes the new "stable". So as soon as the build for the new version succeeds, "stable" gets updated.

So in other words, what Jeremy said was correct. I'll update this to describe that. Thanks for asking... I misunderstood until I found the doc.

Copy link
Contributor

@jeremyliweishih jeremyliweishih left a comment

Choose a reason for hiding this comment

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

Looks good just two little comments.

Copy link
Contributor

@angela97lin angela97lin left a comment

Choose a reason for hiding this comment

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

LGTM!

Only comment I have (this might be a little too particular, lol) is, it'd be nice to standardize some capitalization (ex: GitHub, CircleCI, ReadtheDocs, etc.)

@angela97lin angela97lin self-requested a review April 2, 2020 02:04
@dsherry dsherry merged commit 49026c8 into master Apr 13, 2020
@dsherry dsherry deleted the ds_update_release_notes branch April 13, 2020 22:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement An improvement to an existing feature.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants