You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: RELEASING.md
+12-24Lines changed: 12 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,8 +9,9 @@
9
9
(otherwise the workflow will pick up the version from `main` and just remove the `.dev` suffix).
10
10
* Review the two pull requests that it creates.
11
11
(one is targeted to the release branch and one is targeted to `main`).
12
-
* Merge the one targeted towards the release branch.
13
-
* The builds will fail for the `main` pr because of validation rules. Follow the [release workflow](https://github.com/open-telemetry/opentelemetry-python/blob/main/RELEASING.md) for the core repo up until this same point. Change the SHAs of each PR to point at each other to get the `main` builds to pass.
12
+
* The builds will fail for both the `main` and release pr because of validation rules. Follow the [release workflow](https://github.com/open-telemetry/opentelemetry-python/blob/main/RELEASING.md) for the core repo up until this same point. Change the SHAs of each PR to point at each other to get the `main` and release builds to pass.
13
+
* Merge the release PR.
14
+
* Merge the PR to main (this can be done separately from [making the release](#making-the-release))
14
15
15
16
### Preparing a major or minor release for individual package
16
17
@@ -62,6 +63,7 @@ The workflow can only be run against long-term release branch such as `package-r
62
63
* Review and merge the pull request that it creates for updating the change log in main
63
64
(note that if this is not a patch release then the change log on main may already be up-to-date,
64
65
in which case no pull request will be created).
66
+
* Verify that a new [Github release](https://github.com/open-telemetry/opentelemetry-python-contrib/releases) has been created and that the CHANGELOGs look correct.
65
67
66
68
### Releasing individual package
67
69
@@ -79,6 +81,14 @@ to pick a specific package to release.
79
81
80
82
The workflow can only be run against long-term release branch such as `package-release/{package-name}/v{major}.{minor}.x` or `package-release/{package-name}/v{major}.{minor}bx`.
81
83
84
+
## After the release
85
+
86
+
* Check PyPI
87
+
* This should be handled automatically on release by the [publish action](https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/.github/workflows/release.yml).
88
+
* Check the [action logs](https://github.com/open-telemetry/opentelemetry-python-contrib/actions/workflows/release.yml) to make sure packages have been uploaded to PyPI
89
+
* Check the release history (e.g. https://pypi.org/project/opentelemetry-instrumentation/#history) on PyPI
90
+
* If for some reason the action failed, see [Publish failed](#publish-failed) below
91
+
82
92
## Notes about version numbering for stable components
83
93
84
94
* The version number for stable components in the `main` branch is always `X.Y.0.dev`,
@@ -110,28 +120,6 @@ The workflow can only be run against long-term release branch such as `package-r
110
120
* The version number for unstable components in the `main` branch will be bumped to the next version,
111
121
e.g. `0.{Y+1}b0.dev`.
112
122
113
-
## After the release
114
-
115
-
* Check PyPI
116
-
* This should be handled automatically on release by the [publish action](https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/.github/workflows/release.yml).
117
-
* Check the [action logs](https://github.com/open-telemetry/opentelemetry-python-contrib/actions/workflows/release.yml) to make sure packages have been uploaded to PyPI
118
-
* Check the release history (e.g. https://pypi.org/project/opentelemetry-instrumentation/#history) on PyPI
119
-
* If for some reason the action failed, see [Publish failed](#publish-failed) below
120
-
* Move stable tag
121
-
* Run the following (TODO automate):
122
-
123
-
```bash
124
-
git tag -d stable
125
-
git tag stable
126
-
git push --delete origin tagname
127
-
git push origin stable
128
-
```
129
-
130
-
* This will ensure the docs are pointing at the stable release.
131
-
* To validate this worked, ensure the stable build has run successfully:
If the build has not run automatically, it can be manually trigger via the readthedocs interface.
134
-
135
123
## Releasing dev version of new packages to claim namespace
136
124
137
125
When a contribution introduces a new package, in order to mitigate name-squatting incidents, release the current development version of the new package under the `opentelemetry` user to simply claim the namespace. This should be done shortly after the PR that introduced this package has been merged into `main`.
0 commit comments