Skip to content

Commit

Permalink
Update RELEASING.md to start a ReadTheDocs build for stable (#4308)
Browse files Browse the repository at this point in the history
  • Loading branch information
aabmass authored Nov 22, 2024
1 parent a94eab9 commit 59d6754
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
Binary file added .github/rtd-build-instructions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,18 +46,18 @@
* Check the [action logs](https://github.com/open-telemetry/opentelemetry-python/actions?query=workflow%3APublish) to make sure packages have been uploaded to PyPI
* Check the release history (e.g. https://pypi.org/project/opentelemetry-api/#history) on PyPI
* If for some reason the action failed, see [Publish failed](#publish-failed) below
* Move stable tag
* Move stable tag and kick-off documentation build
* Run the following (TODO automate):
```bash
git tag -d stable
git tag stable
git push --delete origin tagname
git push origin stable
```
* This will ensure that READTHEDOCS for core are pointing at the stable release.
* To validate this worked, ensure the stable build has run successfully:
* ReadTheDocs will not automatically rebuild on tag changes, so manually kick-off a build of stable:
https://readthedocs.org/projects/opentelemetry-python/builds/.
If the build has not run automatically, it can be manually trigger via the READTHEDOCs interface.
![ReadTheDocs build instructions](.github/rtd-build-instructions.png)
* This will ensure that ReadTheDocs for core are pointing at the stable release.

## Notes about version numbering for stable components

Expand Down

0 comments on commit 59d6754

Please sign in to comment.