diff --git a/.github/ISSUE_TEMPLATE/minor-release.md b/.github/ISSUE_TEMPLATE/minor-release.md index ccbdbb3472ffc..d83bc945879a3 100644 --- a/.github/ISSUE_TEMPLATE/minor-release.md +++ b/.github/ISSUE_TEMPLATE/minor-release.md @@ -63,8 +63,8 @@ Automated steps include: - [ ] Ensure any breaking changes are highlighted in the release upgrade guide - [ ] Ensure any deprecations are highlighted in the release upgrade guide - [ ] Review generated changelog entries to ensure they are understandable to end-users -- [ ] Check for any outstanding deprecation actions in [DEPRECATIONS.md](https://github.com/vectordotdev/vector/blob/master/docs/DEPRECATIONS.md) and - take them (or have someone help you take them) + - [ ] Ensure the date matches the scheduled release date. + - [ ] Add a link to pending deprecation items from [DEPRECATIONS.md](https://github.com/vectordotdev/vector/blob/master/docs/DEPRECATIONS.md). - [ ] PR review & approval # On the day of release @@ -72,13 +72,12 @@ Automated steps include: - [ ] Make sure the release branch is in sync with origin/master and has only one squashed commit with all commits from the prepare branch. If you made a PR from the prepare branch into the release branch this should already be the case - [ ] `git checkout "${RELEASE_BRANCH}"` - [ ] `git show --stat HEAD` - This should show the squashed prepare commit - - [ ] `git diff HEAD~1 origin/master --quiet && echo "Same" || echo "Different"` - Should output `Same` + - [ ] Ensure release date in `website/cue/reference/releases/0.XX.Y.cue` matches current date. + - If this needs to be updated commit and squash it in the release branch - Follow these steps if the release branch needs to be updated - [ ] Rebase the release preparation branch on the release branch - [ ] Squash the release preparation commits (but not the cherry-picked commits!) to a single commit. This makes it easier to cherry-pick to master after the release. - - [ ] Ensure release date in `website/cue/reference/releases/0.XX.Y.cue` matches current date. - - If this needs to be updated commit and squash it in the release branch - [ ] Merge release preparation branch into the release branch - `git switch "${RELEASE_BRANCH}" && git merge --ff-only "${PREP_BRANCH}"` diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 76781a822e55d..09fb937bbfb8e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -37,14 +37,14 @@ This should help the reviewers give feedback faster and with higher quality. --> - Some CI checks run only after we manually approve them. - We recommend adding a `pre-push` hook, please see [this template](https://github.com/vectordotdev/vector/blob/master/CONTRIBUTING.md#Pre-push). - Alternatively, we recommend running the following locally before pushing to the remote branch: - - `cargo fmt --all` - - `cargo clippy --workspace --all-targets -- -D warnings` - - `cargo nextest run --workspace` (alternatively, you can run `cargo test --all`) + - `make fmt` + - `make check-clippy` (if there are failures it's possible some of them can be fixed with `make clippy-fix`) + - `make test` - After a review is requested, please avoid force pushes to help us review incrementally. - Feel free to push as many commits as you want. They will be squashed into one before merging. - For example, you can run `git merge origin master` and `git push`. - If this PR introduces changes Vector dependencies (modifies `Cargo.lock`), please - run `cargo vdev build licenses` to regenerate the [license inventory](https://github.com/vectordotdev/vrl/blob/main/LICENSE-3rdparty.csv) and commit the changes (if any). More details [here](https://crates.io/crates/dd-rust-license-tool). + run `make build-licenses` to regenerate the [license inventory](https://github.com/vectordotdev/vrl/blob/main/LICENSE-3rdparty.csv) and commit the changes (if any). More details [here](https://crates.io/crates/dd-rust-license-tool).