Skip to content

Commit

Permalink
Add release process (#121)
Browse files Browse the repository at this point in the history
  • Loading branch information
lucacome authored Jun 5, 2024
1 parent 79293e6 commit 11cfe9c
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 2 deletions.
3 changes: 1 addition & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ that issue here in this description (not in the title of the PR).

Before creating a PR, run through this checklist and mark each as complete.

- [ ] I have read the [CONTRIBUTING](https://github.com/nginxinc/telemetry-exporter/blob/main/CONTRIBUTING.md)
guide
- [ ] I have read the [CONTRIBUTING](https://github.com/nginxinc/telemetry-exporter/blob/main/CONTRIBUTING.md) guide
- [ ] I have proven my fix is effective or that my feature works
- [ ] I have checked that all unit tests pass after adding my changes
- [ ] I have ensured the README is up to date
Expand Down
19 changes: 19 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -83,3 +83,22 @@ jobs:

- name: Run Functional Tests
run: make functional-test

release-notes:
name: Release Notes
runs-on: ubuntu-22.04
permissions:
contents: write
if: github.event_name != 'pull_request'
steps:
- name: Checkout Repository
uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6

- name: Create/Update Draft
uses: lucacome/draft-release@8a63d32c79a171ae6048e614a8988f0ac3ed56d4 # v1.1.0
id: release-notes
with:
minor-label: "enhancement"
major-label: "change"
publish: ${{ github.ref_type == 'tag' }}
collapse-after: 30
30 changes: 30 additions & 0 deletions release-process.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Release Process

This document outlines the steps involved in the release process for the Telemetry Exporter project.

## Versioning

The project follows [Semantic Versioning](https://semver.org/) for versioning.

> Major version zero `(0.Y.Z)` is reserved for development, anything MAY change at any time. The public API is not stable.
## Release Planning and Development

The features that will go into the next release are reflected in the
corresponding [milestone](https://github.com/nginxinc/telemetry-exporter/milestones). Refer to
the [Issue Lifecycle](/ISSUE_LIFECYCLE.md) document for information on issue creation and assignment to releases.

## Releasing a New Version

1. Create an issue to define and track release-related activities. Choose a title that follows the
format `Release X.Y.Z`.
2. Stop merging any new work into the main branch.
3. Check the release draft under the [GitHub releases](https://github.com/nginxinc/telemetry-exporter/releases) page to ensure that everything is in order.
4. Create and push the release tag in the format `vX.Y.Z`:

```bash
git tag -a vX.Y.Z -m "Release vX.Y.Z"
git push origin vX.Y.Z
```

As a result, the CI/CD pipeline will publish the release.

0 comments on commit 11cfe9c

Please sign in to comment.