Skip to content

Commit f50edd4

Browse files
Merge pull request espressif#425 from euripedesrocha/asio_contributing_guide
bump(asio): 1.28.0~0 -> 1.28.2~0
2 parents 93f5f7b + 28f1e43 commit f50edd4

File tree

4 files changed

+53
-2
lines changed

4 files changed

+53
-2
lines changed

components/asio/CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# Changelog
22

3+
## [1.28.2~0](https://github.com/espressif/esp-protocols/commits/asio-1.28.2_0)
4+
5+
### Bug Fixes
6+
7+
- reference protocol_examples_common from IDF ([09abb18](https://github.com/espressif/esp-protocols/commit/09abb18))
8+
- specify override_path in example manifest files ([1d8923c](https://github.com/espressif/esp-protocols/commit/1d8923c))
9+
10+
### Updated
11+
12+
- docs(asio): Updates asio docs ([ce9337d](https://github.com/espressif/esp-protocols/commit/ce9337d))
13+
314
## [1.28.0~0](https://github.com/espressif/esp-protocols/commits/asio-1.28.0~0)
415

516
### Features

components/asio/CONTRIBUTING.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Information for Contributors
2+
3+
Contributions in the form of pull requests, issue reports, and feature requests are welcome!
4+
5+
## Updating ASIO
6+
7+
ASIO is managed as a submodule, to updated the version first the [espressif](github.com/espressif/asio) ASIO fork must be updated.
8+
9+
## Release process
10+
11+
When releasing a new component version we have to:
12+
13+
* Update the submodule reference
14+
* Update the version number
15+
* Update the changelog
16+
17+
And the automation process takes care of the last steps:
18+
19+
* Create the version tag in this repository
20+
* Deploy the component to component registry
21+
* Update the documentation
22+
23+
This process needs to be manually handled for ASIO component since commitizen doesn't accept the versioning schema used.
24+
25+
* Increment manually the version in the [manifest file](idf_component.yml)
26+
* Export environment variables for changelog generation:
27+
- CZ_PRE_CURRENT_TAG_VERSION
28+
- CZ_PRE_NEW_TAG_VERSION
29+
- CZ_PRE_NEW_VERSION
30+
* Run `python ../../ci/changelog.py asio` from this directory to generate the change log
31+
* Check the updated `CHANGELOG.md`
32+
* Commit the changes with the adequated message format.
33+
```
34+
bump(asio): $current_version -> $new_version
35+
36+
$Changelog for the version
37+
```
38+
* Create a PR
39+
40+
Once the PR is merged, the CI job tags the merge commit, creates a new release, builds and deploys documentation and the new component to the component registry

components/asio/asio

Submodule asio updated 49 files

components/asio/idf_component.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
version: "1.28.0~0"
1+
version: "1.28.2~0"
22
description: Cross-platform C++ library for network and I/O programming
33
url: https://github.com/espressif/esp-protocols/tree/master/components/asio
44
issues: https://github.com/espressif/esp-protocols/issues

0 commit comments

Comments
 (0)