From 369ce09a222211f351aead46d03e86991111e9cb Mon Sep 17 00:00:00 2001 From: Franciszek Walkowiak Date: Fri, 25 Aug 2023 15:20:39 +0200 Subject: [PATCH] Add CRAN release template --- .github/ISSUE_TEMPLATE/cran-release.yaml | 101 +++++++++++++++++++++++ 1 file changed, 101 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/cran-release.yaml diff --git a/.github/ISSUE_TEMPLATE/cran-release.yaml b/.github/ISSUE_TEMPLATE/cran-release.yaml new file mode 100644 index 00000000..49a81e67 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/cran-release.yaml @@ -0,0 +1,101 @@ +--- +name: 🎉 CRAN Release +description: Template for release to CRAN +title: "[Release]: " +labels: ["release"] +assignees: + - KlaudiaBB + - cicdguy + - shajoezhu +body: + - type: markdown + attributes: + value: | + ⚠️ Please do not link or mention any internal references in this issue. This includes internal URLs, intellectual property and references. + - type: textarea + id: blocked-by + attributes: + label: Blocked by + description: Any PRs or issues that this release is blocked by. + placeholder: Add a list of blocking PRs or issues here. + value: | + ### PRs + + - [ ] PR 1 + + ### Issues + + - [ ] Issue 1 + validations: + required: true + - type: textarea + id: pre-requisites + attributes: + label: Pre-requisites + description: Pre-requisites that must be fulfilled before initiating the release process. + placeholder: Add your list of pre-requisites here. + value: | + - [ ] Make sure that high priority bugs (label "priority" + "bug") have been resolved before going into the release. + - [ ] Review old/hanging PRs before going into the release (Optional). + - [ ] Revisit R-package's lifecycle badges (Optional). + - [ ] Make sure that all upstream dependencies of this package that need to be submitted to CRAN were accepted before going into release activities. + - [ ] Make sure integration tests are green 2-3 days before the release. Look carefully through logs (check for warnings and notes). + - [ ] Decide what gets merged in before starting release activities. + - type: textarea + id: release-checklist + attributes: + label: Release Checklist + description: The steps to be taken in order to create a release. + placeholder: Steps to create a release. + value: | + - [ ] Update NEWS.md file: make sure it reflects a holistic summary of what has changed in the package. + - [ ] Remove the additional fields (`Remotes` and `Config/Needs/*`) from the DESCRIPTION file where applicable. + - [ ] Increase versioned dependency on {package name} to >=X.X.X (Optional). + - [ ] Make sure that the minimum dependency versions are updated in the DESCRIPTION file for the package and its reverse dependencies (Optional). + - [ ] Create a pull request to make necessary bug fixes/changes (add "[skip vbump]" in the pr title), and after merging the PR, tag the update(s) as a release candidate v < intended release version > -rc < release candidate iteration > on the main branch. + - [ ] Build the package locally using the command:`R CMD build .` which will generate a .tar.gz file necessary for the CRAN submission. + - [ ] Submit the package that was build in the previous step via this form: https://cran.r-project.org/submit.html. + - [ ] Address CRAN feedback, tag the package vX.X.X-rc(n+1) and repeat the submission to CRAN whenever necessary. + - [ ] Get the package accepted and published on CRAN. + - [ ] If the additional fields were removed, add them back in a separate PR, and then merge the PR back to main. Note: Take precautionary measures to ensure that the version bump does not take place on a merge. + - [ ] Create a git tag with the final version set to X.X.X on the main branch. + - type: textarea + id: testing + attributes: + label: Testing + description: Summary of testing activities - integration tests, UAT, other + placeholder: Tests results + value: | + - [ ] Integration tests results - accepted. + - [ ] UAT results - accepted. + - [ ] All testing activities are finalized. + - type: textarea + id: feedback + attributes: + label: Release Feedback + description: Feedback received from CRAN/testers. + placeholder: Feedback to be implemented after CRAN submission/testing. + value: | + - [ ] Fix 1 + - [ ] Enhancement 1 + - [ ] Defect 1 + - type: textarea + id: post-release + attributes: + label: Post-release Checklist + description: The list of activities to be completed after the release. + placeholder: The steps that must be taken after the release. + value: | + - [ ] Make sure that the package is published to internal repositories. + - [ ] Review and update installation instructions for the package wherever needed (Optional). + - [ ] Update all integration tests to reference the new release. + - [ ] Ensure a new dev version (.9XXX) is added to the NEWS.md file and DESCRIPTION file as a placeholder for release notes. + - [ ] Announce the release on ________. + - type: textarea + id: decision-tree + attributes: + label: Decision tree + description: Any decision tree(s) that would aid release management + placeholder: Any decision tree(s) that would aid release management. + value: | + Click [here](https://github.com/insightsengineering/.github/blob/main/.github/ISSUE_TEMPLATE/RELEASE_DECISION_TREE.md) to see the release decision tree.