Skip to content

Commit

Permalink
Release docs update (#387)
Browse files Browse the repository at this point in the history
* Created GH action to run the changelog entries draft script

* Updating the release doc

* Update wording
  • Loading branch information
LikeTheSalad authored May 30, 2024
1 parent b4acde7 commit c9215ff
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
12 changes: 12 additions & 0 deletions .github/workflows/draft-change-log-entries.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Draft CHANGELOG entries for a release

on:
workflow_dispatch:

jobs:
create_draft:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Run changelog draft script
run: sh .github/scripts/draft-change-log-entries.sh
3 changes: 2 additions & 1 deletion RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ We first need to prepare the release. This creates a versioned release branch, T
- Make sure that the `gradle.properties` version property is set to the value you want to release.
This must be different than the most recent release number (typically one minor version increase).
- Merge a pull request to `main` branch that updates the `CHANGELOG.md`.
- The heading for the unreleased entries must be `## Unreleased`.
- The heading for the unreleased entries must be `## Unreleased`.
- Use [this action](https://github.com/open-telemetry/opentelemetry-android/actions/workflows/draft-change-log-entries.yaml) as a starting point for writing the change log entries. It will print a draft in the console that you can copy to create your PR.
- Go to the
[prepare-release-branch action](https://github.com/open-telemetry/opentelemetry-android/actions/workflows/prepare-release-branch.yml)
in Github and click on "Run workflow".
Expand Down

0 comments on commit c9215ff

Please sign in to comment.