Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[8.14] ci(release): update descriptions and use oblt-actions@v1 (backport #13529) #13532

Merged
merged 3 commits into from
Jul 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/prepare-release/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ runs:
steps:
- name: Send slack message when started
id: slack-thread
uses: elastic/oblt-actions/slack/send@v1.8.0
uses: elastic/oblt-actions/slack/send@v1
with:
bot-token: ${{ inputs.slack-bot-token }}
channel-id: ${{ env.SLACK_CHANNEL }}
Expand Down Expand Up @@ -89,7 +89,7 @@ runs:
TAG: 'refs/tags/v${{ steps.generate.outputs.release-version }}'

- if: failure()
uses: elastic/oblt-actions/slack/send@v1.8.0
uses: elastic/oblt-actions/slack/send@v1
with:
bot-token: ${{ inputs.slack-bot-token }}
channel-id: ${{ env.SLACK_CHANNEL }}
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/run-minor-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ on:
workflow_dispatch:
inputs:
version:
description: 'The version (semver format: major.minor.0)'
description: 'The new version to be set, normally the version in the main branch (semver format: major.minor.0)'
required: true
type: string

Expand Down Expand Up @@ -67,9 +67,9 @@ jobs:
# GitHub bot won't trigger any CI builds.
# See https://github.com/peter-evans/create-pull-request/issues/48#issuecomment-537478081
- name: Configure git user
uses: elastic/apm-pipeline-library/.github/actions/setup-git@current
uses: elastic/oblt-actions/git/setup@v1
with:
token: ${{ env.GH_TOKEN }}
github-token: ${{ env.GH_TOKEN }}

- name: Import GPG key
uses: crazy-max/ghaction-import-gpg@01dd5d3ca463c7f10f7f4f7b4f177225ac661ee4 # v6.1.0
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/run-patch-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ on:
workflow_dispatch:
inputs:
version:
description: 'The version (semver format: major.minor.patch)'
description: 'The current version to be released, normally the `FF version` (semver format: major.minor.patch)'
required: true
type: string

Expand Down Expand Up @@ -60,9 +60,9 @@ jobs:
# GitHub bot won't trigger any CI builds.
# See https://github.com/peter-evans/create-pull-request/issues/48#issuecomment-537478081
- name: Configure git user
uses: elastic/apm-pipeline-library/.github/actions/setup-git@current
uses: elastic/oblt-actions/git/setup@v1
with:
token: ${{ env.GH_TOKEN }}
github-token: ${{ env.GH_TOKEN }}

- name: Import GPG key
uses: crazy-max/ghaction-import-gpg@01dd5d3ca463c7f10f7f4f7b4f177225ac661ee4 # v6.1.0
Expand All @@ -75,7 +75,7 @@ jobs:
- run: make patch-release

- if: success()
uses: elastic/oblt-actions/slack/send@v1.8.0
uses: elastic/oblt-actions/slack/send@v1
with:
bot-token: ${{ secrets.SLACK_BOT_TOKEN }}
channel-id: ${{ env.SLACK_CHANNEL }}
Expand All @@ -85,7 +85,7 @@ jobs:
thread-timestamp: ${{ needs.prepare.outputs.slack-thread || '' }}

- if: failure()
uses: elastic/oblt-actions/slack/send@v1.8.0
uses: elastic/oblt-actions/slack/send@v1
with:
bot-token: ${{ secrets.SLACK_BOT_TOKEN }}
channel-id: ${{ env.SLACK_CHANNEL }}
Expand Down
11 changes: 11 additions & 0 deletions dev_docs/RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,17 @@ For patch releases, only the version on the existing major and minor version bra
and update versions to next minor version, e.g. [#2804](https://github.com/elastic/apm-server/pull/2804).

The release manager will ping the teams, but you can already prepare this in advance on the day after Feature Freeze.
* Trigger release workflow manually
* For **patch releases**: run the [`run-patch-release`](https://github.com/elastic/apm-server/actions/workflows/run-patch-release.yml) workflow (In "Use workflow from", select `main` branch. Then in "The version", specify the **upcoming** patch release version - es: on `8.14.2` feature freeze you will use `8.14.2`).
This workflow will: create the release branch; update version across codebase; commit and create PR targeting the release branch.
Release notes for patch releases **must be manually added**:
* Add a new section to the existing release notes file ([Sample PR](https://github.com/elastic/apm-server/pull/12680)).
* Review the [changelogs/head](https://github.com/elastic/apm-server/tree/main/changelogs/head.asciidoc) file and move relevant changelog entries from `head.asciidoc` to `release_version.asciidoc` if the change is backported to release_version. If changes do not apply to the version being released, keep them in the `head.asciidoc` file.
* Review the commits in the release to ensure all changes are reflected in the release notes.
* Add your PR to the documentation release issue ([Sample Issue](https://github.com/elastic/dev/issues/2485)).
* For **minor releases**: run the [`run-minor-release`](https://github.com/elastic/apm-server/actions/workflows/run-minor-release.yml) workflow (In "Use workflow from", select `main` branch. Then in "The version", specify the minor release version the release is for).
This workflow will: create the release branch; update the changelog for the release branch and open a PR targeting the release branch titled `<major>.<minor>: update docs`; create a PR on `main` titled `<major>.<minor>: update docs, mergify, versions and changelogs`. Before merging them compare commits between latest minor and the new minor versions and ensure all relevant PRs have been included in the Changelog. If not, amend it in both PRs. Request and wait a PR review from the team before merging.
* The Release Manager will ping the team to align the release process

* Update dependencies

Expand Down