Skip to content

Commit

Permalink
Document the Release Process (#244)
Browse files Browse the repository at this point in the history
* feat(forge): Support hierarchical weaver config

* feat(forge): Test override_with

* feat(forge): Implement better UX for templates and config.

* chore(forge): Fix a unit test.

* feat(forge): Support multiple paths to init a WeaverConfig with overriding support.

* feat(cli): Reintroduce target concept

* feat(cli): Introduce --config parameter in weaver registry generate

* doc(forge): Document the organization and resolution of config files

* doc(forge): Document the organization and resolution of config files

* feat(forge): Improve WeaverConfig and TemplateEngine public APIs

* feat(forge): Remove FileContent from the public API

* feat(forge): Create constants for Jinja syntax delimiters

* chore(forge): Remove unused filters function_name, struct_name, ...

* chore(build): Merge with main and bump weaver version

* chore(release): Describe release process
  • Loading branch information
lquerel authored Jul 16, 2024
1 parent 9219ccc commit 7cbf1e1
Show file tree
Hide file tree
Showing 2 changed files with 110 additions and 0 deletions.
15 changes: 15 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,21 @@

All notable changes to this project will be documented in this file.

## [0.6.0] - 2024-07-16

What's Changed

* Support for Hierarchical Weaver Config: We have added support for hierarchical configuration in Weaver.
This allows more flexible and powerful configuration management. For more details, please refer to the
documentation on [configuration file loading order and overriding rules](https://github.com/open-telemetry/weaver/blob/main/docs/weaver-config.md#configuration-file-loading-order-and-overriding-rules). by @lquerel in https://github.com/open-telemetry/weaver/pull/231
* Support for MiniJinja py_compat Extensions: This release includes support for MiniJinja py_compat
extensions, enhancing compatibility with Python syntax. For more information, see the [documentation](https://github.com/open-telemetry/weaver/blob/main/crates/weaver_forge/README.md#jinja-filters). by @lquerel
in https://github.com/open-telemetry/weaver/pull/239

## New Contributors

* @haidong made a first contribution in https://github.com/open-telemetry/weaver/pull/237

## [0.5.0] - 2024-07-02

What's Changed
Expand Down
95 changes: 95 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,101 @@ A PR is considered to be ready to merge when:

Any Maintainer can merge the PR once it is ready to merge. Note, that some PRs may not be merged immediately if the repo is in the process of a release and the maintainers decided to defer the PR to the next release train. Also, maintainers may decide to wait for more than one approval for certain PRs, particularly ones that are affecting multiple areas, or topics that may warrant more discussion.

### Creating a New Release for the Weaver Project

To create a new release for the Weaver project, follow these steps. This process ensures that the release is properly
versioned, documented, and published using our CI/CD pipeline.

#### 1. Prepare a Pull Request

Before creating a release tag, you need to prepare a Pull Request (PR) with the following updates:

1. **Update Versions**: Bump the version numbers for all crates in the project.
2. **Update CHANGELOG.md**: Add appropriate entries in `CHANGELOG.md` to reflect the new release, detailing the changes,
enhancements, and bug fixes.

##### Steps:

1. **Checkout a new branch**:
```bash
git checkout -b prepare-release-vX.Y.Z
```

2. **Update the version numbers**: Update the `Cargo.toml` files in each crate to reflect the new version.

3. **Update CHANGELOG.md**: Add a new section for the upcoming release version and list all relevant changes.

4. **Commit your changes**:
```bash
git add .
git commit -m "Prepare release vX.Y.Z"
```

5. **Push your branch**:
```bash
git push origin prepare-release-vX.Y.Z
```

6. **Open a Pull Request**: Go to the GitHub repository and open a PR from your branch. Request reviews and wait for
approval.

#### 2. Merge the PR

Once the PR is reviewed and approved, merge it into the `main` branch.

#### 3. Create and Push a Signed Tag

After merging the PR, create a signed tag for the new release.

##### Steps:

1. **Checkout the `main` branch**:
```bash
git checkout main
git pull origin main
```

2. **Create a signed tag**:
```bash
git tag -s vX.Y.Z -m "Release vX.Y.Z"
```
Replace `X.Y.Z` with the new version number. You will be prompted to enter your GPG passphrase to sign the tag.

3. **Push the tag to the upstream repository**:
```bash
git push upstream vX.Y.Z
```

#### 4. Monitor the CI/CD Process

After pushing the tag, the GitHub Actions workflow configured in
[`.github/workflows/release.yml`](https://github.com/open-telemetry/weaver/blob/main/.github/workflows/release.yml) will
automatically detect the new tag. This workflow uses `cargo-dist` to create the release and its artifacts.

##### Steps:

1. **Check the Actions Tab**: Go to the "Actions" tab in the GitHub repository to monitor the CI/CD process. Four workflows should be triggered:
- **CI**
- **Release**
- **Spelling**
- **Weaver Docker Generator**

2. **Ensure All Workflows Complete Successfully**: Wait for all four workflows to complete. Each workflow should finish without errors.

#### 5. Verify and Update Release Description

Once all workflows are successful:

1. **Check the Release List**: Go to the "Releases" section of the Weaver project on GitHub.
2. **Update the Release Description**: Edit the release description to ensure it is complete and informative. At this
time, we do not have an automation for generating a detailed release description, so this step needs to be done manually.

#### 6. Announce the Release

The final step is to announce the new release:

1. **Post in the Slack Channel**: Inform the team and the community about the new release by posting an announcement in
the relevant Slack channel. Include a summary of the key changes and a link to the release notes.

### Repository background

Expand Down

0 comments on commit 7cbf1e1

Please sign in to comment.