Skip to content

Commit a10faaf

Browse files
authored
Add excerpt for hotfixes (open-telemetry#1925)
1 parent d724573 commit a10faaf

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ env:
1010
# Otherwise, set variable to the commit of your branch on
1111
# opentelemetry-python-contrib which is compatible with these Core repo
1212
# changes.
13-
CONTRIB_REPO_SHA: 82c4f600872a72fedaebad758f0d5588dfb53a00
13+
CONTRIB_REPO_SHA: c100b21fa40727709bb31cf4e2b67b737a09ea2c
1414

1515
jobs:
1616
build:

RELEASING.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,6 @@ run eachdist once again:
7373
./scripts/eachdist.py update_versions --versions stable,prerelease
7474
```
7575

76-
7776
## Update website docs
7877

7978
If the docs for the Opentelemetry [website](https://opentelemetry.io/docs/python/) was updated in this release in this [folder](https://github.com/open-telemetry/opentelemetry-python/tree/main/website_docs), submit a [PR](https://github.com/open-telemetry/opentelemetry.io/tree/main/content/en/docs/python) to update the docs on the website accordingly. To check if the new version requires updating, run the following script and compare the diff:
@@ -84,6 +83,21 @@ If the docs for the Opentelemetry [website](https://opentelemetry.io/docs/python
8483

8584
If the diff includes significant changes, create a pull request to commit the changes and once the changes are merged, click the "Run workflow" button for the Update [OpenTelemetry Website Docs](https://github.com/open-telemetry/opentelemetry-python/actions/workflows/docs-update.yml) GitHub Action.
8685

86+
## Hotfix procedure
87+
88+
A `hotfix` is defined as a small change developed to correct a bug that should be released as quickly as possible. Due to the nature of hotfixes, they usually will only affect one or a few packages. Therefore, it usually is not necessary to go through the entire release process outlined above for hotfixes. Follow the below steps how to release a hotfix:
89+
90+
1. Identify the packages that are affected by the bug. Make the changes to those packages, merging to `main`, as quickly as possible.
91+
2. On your local machine, remove the `dev0` tags from the version number and increment the patch version number.
92+
3. On your local machine, update `CHANGELOG.md` with the date of the hotfix change.
93+
4. With administrator priviledges for PyPi, manually publish the affected packages.
94+
a. Install [twine](https://pypi.org/project/twine/)
95+
b. Navigate to where the `setup.py` file exists for the package you want to publish.
96+
c. Run `python setup.py sdist bdist_wheel`. You may have to install [wheel](https://pypi.org/project/wheel/) as well.
97+
d. Validate your built distributions by running `twine check dist/*`.
98+
e. Upload distibutions to PyPi by running `twine upload dist/*`.
99+
5. Note that since hotfixes are manually published, the build scripts for publish after creating a release are not run.
100+
87101
## Troubleshooting
88102

89103
### Publish failed

0 commit comments

Comments
 (0)