Thanks to visit codestin.com
Credit goes to github.com

Skip to content

v0.4a1 release to host alpha docs #458

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

Merged
merged 3 commits into from
Mar 4, 2020
Merged

Conversation

c24t
Copy link
Member

@c24t c24t commented Mar 2, 2020

This PR cherry-picks a9e52b8 from master onto the 0.4a.x release branch so we can build docs for the last-released version of the library and host on readthedocs.org. The goal is to make the default "stable" release docs on readthedocs.org match the version of the library that users get by installing the package from PyPI when they don't specify a version.

This will be the first micro/patch-level release for this library, which would usually be reserved for non-API-breaking bug fixes. The process I've followed for this release is:

  1. Patch changes in from master
  2. Update all version numbers and dependencies (0.4a0 packages can use 0.4a1 dependencies, but not vice-versa)
  3. Update changelogs
  4. (TODO after merging this PR) cut a new release from the target branch
  5. (also TODO) push new artifacts built from this branch to PyPI

This is a lot of ceremony for a trivial change, but AFAICT this is all required if we want every change to a release branch to result in a micro/patch version update, and if we want to keep the version numbers for all packages in sync.

@c24t c24t added build & infra Issues related to build & infrastructure. release labels Mar 2, 2020
@c24t c24t requested a review from a team March 2, 2020 20:42
@@ -39,7 +39,7 @@ package_dir=
=src
packages=find_namespace:
install_requires =
opentelemetry-api >= 0.4a0
opentelemetry-api >= 0.4a1
Copy link
Member Author

Choose a reason for hiding this comment

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

Dependencies could technically be >=0.4a0 or ~=0.4a since the API shouldn't change between micro versions, but I thought it would be easier to keep all package in sync. I'm interested to hear others' thoughts on this.

@codecov-io
Copy link

codecov-io commented Mar 2, 2020

Codecov Report

Merging #458 into v0.4a.x will not change coverage.
The diff coverage is 100%.

Impacted file tree graph

@@           Coverage Diff            @@
##           v0.4a.x     #458   +/-   ##
========================================
  Coverage    88.25%   88.25%           
========================================
  Files           41       41           
  Lines         2078     2078           
  Branches       238      238           
========================================
  Hits          1834     1834           
  Misses         172      172           
  Partials        72       72
Impacted Files Coverage Δ
...try-ext-wsgi/src/opentelemetry/ext/wsgi/version.py 100% <100%> (ø) ⬆️
...y-ext-flask/src/opentelemetry/ext/flask/version.py 100% <100%> (ø) ⬆️
.../src/opentelemetry/ext/opentracing_shim/version.py 100% <100%> (ø) ⬆️
...sts/src/opentelemetry/ext/http_requests/version.py 100% <100%> (ø) ⬆️

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 b2b0bbe...01ad011. Read the comment docs.

@c24t
Copy link
Member Author

c24t commented Mar 3, 2020

Docs built from a testing branch with these changes: https://opentelemetry-python.readthedocs.io/en/v0.4a1-rtd-test/.

I'll delete the branch once this is merged.

Copy link
Contributor

@codeboten codeboten 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 1 non blocking question

Copy link
Member

@mauriciovasquezbernal mauriciovasquezbernal left a comment

Choose a reason for hiding this comment

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

LGTM!

@mauriciovasquezbernal
Copy link
Member

Btw, I am able to merge this one, it means that branch protection rules are missing on release branches.

@c24t
Copy link
Member Author

c24t commented Mar 4, 2020

Btw, I am able to merge this one, it means that branch protection rules are missing on release branches.

Good catch. I added a new branch protection rule with the same settings as master:

Screen Shot 2020-03-04 at 10 10 02 AM

@c24t c24t merged commit 1e3768c into open-telemetry:v0.4a.x Mar 4, 2020
@c24t c24t deleted the v0.4a1-rtd branch March 4, 2020 18:13
@c24t
Copy link
Member Author

c24t commented Mar 4, 2020

We need to merge #461 into the release branch to push the new packages to PyPI.

@c24t
Copy link
Member Author

c24t commented Mar 4, 2020

We now have three versions of the docs up on RTD: v0.4.1, latest (which builds from master), and stable (which redirects to v0.4.1).

srikanthccv pushed a commit to srikanthccv/opentelemetry-python that referenced this pull request Nov 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build & infra Issues related to build & infrastructure.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants