Skip to content

Commit e9e72ae

Browse files
authored
Use HTTPS URL for the submodule (#17)
- Fix RELEASE_NOTES template - Clear release notes - Use HTTPS to retrieve the submodule
2 parents 5b3c5e5 + eed2d37 commit e9e72ae

File tree

3 files changed

+22
-4
lines changed

3 files changed

+22
-4
lines changed

.github/RELEASE_NOTES.template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Frequenz Migrogrid API Release Notes
1+
# Frequenz Common API Release Notes
22

33
## Summary
44

.gitmodules

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
[submodule "submodules/api-common-protos"]
22
path = submodules/api-common-protos
3-
url = git@github.com:googleapis/api-common-protos.git
3+
url = https://github.com/googleapis/api-common-protos.git

RELEASE_NOTES.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,23 @@
22

33
## Summary
44

5-
- Various build system fixes
6-
- Improved smoothness of using this as a dependency
5+
<!-- Here goes a general summary of what this release is about -->
6+
7+
## Upgrading
8+
9+
* The submodule URL was changed to use HTTPS instead of SSH (to avoid problems trying to unlock SSH keys to do updates, etc.).
10+
11+
Make sure you sync your submodules to the new URL:
12+
13+
```console
14+
$ git submodule sync
15+
Synchronizing submodule url for 'submodules/api-common-protos'
16+
```
17+
18+
## New Features
19+
20+
<!-- Here goes the main new features and examples or instructions on how to use them -->
21+
22+
## Bug Fixes
23+
24+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

0 commit comments

Comments
 (0)