Skip to content

Commit 392d058

Browse files
munoztd0munoztd0
authored
Issue and PR templates (#60)
* issue and PR templates * Update pkgdown.yaml stop running pkgdown for draft PRs
1 parent 26e7c34 commit 392d058

File tree

6 files changed

+302
-0
lines changed

6 files changed

+302
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: 🐞 Bug Report
3+
description: File a bug report
4+
title: "[Bug]: <title>"
5+
labels: ["bug"]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out this bug report!
11+
- type: textarea
12+
id: what-happened
13+
attributes:
14+
label: What happened?
15+
description: Also tell us, what did you expect to happen?
16+
placeholder: Tell us what you see!
17+
value: "A bug happened!"
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: session-info
22+
attributes:
23+
label: sessionInfo()
24+
description: Please copy and paste your output from `sessionInfo()`. This will be automatically formatted into code, so no need for backticks.
25+
render: R
26+
- type: textarea
27+
id: logs
28+
attributes:
29+
label: Relevant log output
30+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
31+
render: R

‎.github/ISSUE_TEMPLATE/cran-release.yml‎

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
---
2+
name: 🎉 CRAN Release
3+
description: Template for release to CRAN
4+
title: "[CRAN Release]: <version>"
5+
labels: ["release"]
6+
assignees:
7+
- KlaudiaBB
8+
- cicdguy
9+
body:
10+
- type: markdown
11+
attributes:
12+
value: |
13+
⚠️ Please do not link or mention any internal references in this issue. This includes internal URLs, intellectual property and references.
14+
- type: textarea
15+
id: blocked-by
16+
attributes:
17+
label: Blocked by
18+
description: Any PRs or issues that this release is blocked by.
19+
placeholder: Add a list of blocking PRs or issues here.
20+
value: |
21+
#### PRs
22+
- [ ] PR 1
23+
24+
#### Issues
25+
- [ ] Issue 1
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: pre-release
30+
attributes:
31+
label: Pre-release
32+
description: Pre-requisites that must be fulfilled before initiating the release process.
33+
placeholder: Add your list of pre-requisites here.
34+
value: |
35+
- [ ] Make sure you adhere to CRAN submission policy:
36+
* https://cran.r-project.org/web/packages/submission_checklist.html
37+
* https://cran.r-project.org/web/packages/policies.html.
38+
- [ ] Make sure that high priority bugs (label "priority" + "bug") have been resolved before going into the release.
39+
- [ ] Review old/hanging PRs before going into the release (Optional).
40+
- [ ] Revisit R-package's lifecycle badges (Optional).
41+
- [ ] Make sure that all upstream dependencies of this package that need to be submitted to CRAN were accepted before going into release activities.
42+
- [ ] Make sure integration tests are green 2-3 days before the release. Look carefully through logs (check for warnings and notes).
43+
- [ ] Decide what gets merged in before starting release activities.
44+
- type: textarea
45+
id: release
46+
attributes:
47+
label: Release
48+
description: The steps to be taken in order to create a release.
49+
placeholder: Steps to create a release.
50+
value: |
51+
#### Prepare the release
52+
- [ ] Create a new release candidate branch
53+
`git checkout -b release-candidate-vX.Y.Z`
54+
- [ ] Update NEWS.md file: make sure it reflects a holistic summary of what has changed in the package.
55+
- [ ] Remove the additional fields (`Remotes`) from the DESCRIPTION file where applicable.
56+
- [ ] Make sure that the minimum dependency versions are updated in the DESCRIPTION file for the package and its reverse dependencies (Optional).
57+
- [ ] Increase versioned dependency on {package name} to >=X.Y.Z (Optional).
58+
- [ ] Commit your changes and create the PR on GitHub (add "[skip vbump]" in the PR title). Add all updates, commit, and push changes:
59+
```r
60+
# Make the necessary modifications to your files
61+
# Stage the changes
62+
git add <files your modified>
63+
# Commit the changes
64+
git commit -m "[skip vbump] <Your commit message>"
65+
git push origin release-candidate-vX.Y.Z`
66+
```
67+
68+
69+
#### Test the release
70+
- [ ] Execute the manual tests on Shiny apps that are deployed on various hosting providers (Posit connect and shinyapps.io) - track the results in GitHub issue (Applicable only for frameworks that use Shiny).
71+
- [ ] Monitor integration tests, if integration fails, create priority issues on the board.
72+
- [ ] Execute UAT tests (Optional).
73+
74+
#### CRAN submission
75+
- [ ] Tag the update(s) as a release candidate vX.Y.Z-rc<iteration-number> (e.g. v0.5.3-rc1) on the release candidate branch (release-candidate-vX.Y.Z).
76+
```r
77+
# Create rc tag for submission for internal validation
78+
git tag vX.Y.Z-rc<iteration number>
79+
git push origin vX.Y.Z-rc<iteration number>
80+
```
81+
- [ ] Build the package locally using the command:`R CMD build .` which will generate a .tar.gz file necessary for the CRAN submission.
82+
- [ ] Submit the package to https://win-builder.r-project.org/upload.aspx for testing, for more details please see "Building and checking R source packages for Windows": https://win-builder.r-project.org/.
83+
- [ ] Once tested, send the package that was built in the previous steps to CRAN via this form: https://cran.r-project.org/submit.html.
84+
- [ ] Address CRAN feedback, tag the package vX.Y.Z-rc(n+1) and repeat the submission to CRAN whenever necessary.
85+
- [ ] Get the package accepted and published on CRAN.
86+
87+
#### Tag the release
88+
- [ ] If the additional fields were removed, add them back in a separate PR, and then merge the PR back to main (add "[skip vbump]" in the PR title). If nothing was removed just merge the PR you created in the "Prepare the release" section to 'main'. Note the commit hash of the merged commit. **Note:** additional commits might be added to the `main` branch by a bot or an automation - we do **NOT** want to tag this commit.
89+
90+
##### Make sure of the following before continuing
91+
- [ ] CI checks are passing in GH before releasing the package.
92+
- [ ] Shiny apps are deployable and there are no errors/warnings (Applicable only for frameworks that use Shiny).
93+
94+
- [ ] Create a git tag with the final version set to vX.Y.Z on the main branch. In order to do this:
95+
1. Checkout the commit hash.
96+
`git checkout <commit hash>`
97+
2. Tag the hash with the release version (vX.Y.Z).
98+
`git tag vX.Y.Z`
99+
3. Push the tag to make the final release.
100+
`git push origin vX.Y.Z`
101+
- [ ] Update downstream package dependencies to (>=X.Y.Z) in {package name}.
102+
**Note:** Once the release tag is created, the package is automatically published to internal repositories.
103+
- type: textarea
104+
id: post-release
105+
attributes:
106+
label: Post-release
107+
description: The list of activities to be completed after the release.
108+
placeholder: The steps that must be taken after the release.
109+
value: |
110+
- [ ] Ensure that CRAN checks are passing for the package.
111+
- [ ] Make sure that the package is published to internal repositories.
112+
- [ ] Make sure internal documentation is up to date.
113+
- [ ] Review and update installation instructions for the package wherever needed (Optional).
114+
- [ ] Announce the release on ________.
115+
- type: textarea
116+
id: decision-tree
117+
attributes:
118+
label: Decision tree
119+
description: Any decision tree(s) that would aid release management
120+
placeholder: Any decision tree(s) that would aid release management.
121+
value: |
122+
Click [here](https://github.com/insightsengineering/.github/blob/main/.github/ISSUE_TEMPLATE/RELEASE_DECISION_TREE.md) to see the release decision tree.

‎.github/ISSUE_TEMPLATE/feature.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: ✨ Feature Request
3+
description: Request or propose a new feature
4+
title: "[Feature Request]: <title>"
5+
labels: ["enhancement"]
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: Feature description
10+
description: |
11+
Do not use this form to ask a question, or ask for assistance.
12+
Is your feature request related to a problem? Please describe with a clear and concise description of the problem. \n\n
13+
Could you describe the solution you would like? Please provide a clear and concise description of what you want to happen.

‎.github/ISSUE_TEMPLATE/release.yml‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
---
2+
name: 🚀 Release
3+
description: Template for package release
4+
title: "[Release]: <version>"
5+
labels: ["release"]
6+
assignees:
7+
- munoztd0
8+
- gmbecker
9+
body:
10+
- type: markdown
11+
attributes:
12+
value: |
13+
⚠️ Please do not link or mention any internal references in this issue. This includes internal URLs, intellectual property and references.
14+
- type: textarea
15+
id: blocked-by
16+
attributes:
17+
label: Blocked by
18+
description: Any PRs or issues that this release is blocked by.
19+
placeholder: Add a list of blocking PRs or issues here.
20+
value: |
21+
#### PRs
22+
- [ ] PR 1
23+
24+
#### Issues
25+
- [ ] Issue 1
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: pre-release
30+
attributes:
31+
label: Pre-release
32+
description: Pre-requisites that must be fulfilled before initiating the release process.
33+
placeholder: Add your list of pre-requisites here.
34+
value: |
35+
- [ ] Make sure that high priority bugs (label "priority" + "bug") have been resolved before going into the release.
36+
- [ ] Review old/hanging PRs before going into the release.
37+
- [ ] Revisit R-package's lifecycle badges (Optional).
38+
- [ ] Release Manager: Discuss package dependencies, create a plan to sequentially close release activities and submit groups of packages for internal validation (Applicable only for regulatory release).
39+
- [ ] Check Validation Pipeline dry-run results for the package.
40+
- [ ] Make sure all relevant integration tests are green 2-3 days before the release. Look carefully through logs (check for warnings and notes).
41+
- [ ] Inform about the soft code freeze, decide what gets merged in before starting release activities.
42+
- type: textarea
43+
id: release
44+
attributes:
45+
label: Release
46+
description: The steps to be taken in order to create a release.
47+
placeholder: Steps to create a release.
48+
value: |
49+
#### Prepare the release
50+
- [ ] Create a new release candidate branch
51+
`git checkout -b release-candidate-vX.Y.Z`
52+
- [ ] Update NEWS.md file: make sure it reflects a holistic summary of what has changed in the package, check README.
53+
- [ ] Remove the additional fields (`Remotes`) from the DESCRIPTION file where applicable.
54+
- [ ] Make sure that the minimum dependency versions are updated in the DESCRIPTION file for the package.
55+
- [ ] Increase versioned dependency on {package name} to >=X.Y.Z.
56+
- [ ] Commit your changes and create the PR on GitHub (add "[skip vbump]" in the PR title). Add all updates, commit, and push changes:
57+
```r
58+
# Make the necessary modifications to your files
59+
# Stage the changes
60+
git add <files your modified>
61+
# Commit the changes
62+
git commit -m "[skip vbump] <Your commit message>"
63+
git push origin release-candidate-vX.Y.Z
64+
```
65+
66+
67+
#### Test the release
68+
- [ ] Execute the manual tests on Shiny apps that are deployed on various hosting providers (Posit connect and shinyapps.io) - track the results in GitHub issue (Applicable only for frameworks that use Shiny).
69+
- [ ] Monitor integration tests, if integration fails, create priority issues on the board.
70+
- [ ] Execute UAT tests (Optional).
71+
72+
73+
#### Validation loop
74+
75+
**Note:** This section is applicable only for regulatory packages.
76+
77+
- [ ] Tag the update(s) as a release candidate vX.Y.Z-rc<iteration-number> (e.g. v0.5.3-rc1) on the release candidate branch (release-candidate-vX.Y.Z).
78+
```r
79+
# Create rc tag for submission for internal validation
80+
git tag vX.Y.Z-rc<iteration number>
81+
git push origin vX.Y.Z-rc<iteration number>
82+
```
83+
- [ ] Submit the package for internal validation.
84+
- [ ] Address any feedback (internal validation/user testing), retag the package as a release candidate vX.Y.Z-rc(n+1). Repeat the submission for internal validation if necessary.
85+
- [ ] Get the package validated.
86+
87+
#### Tag the release
88+
- [ ] If the additional fields were removed, add them back in a separate PR, and then merge the PR back to main (add "[skip vbump]" in the PR title). If nothing was removed just merge the PR you created in the "Prepare the release" section to `main`. Note the commit hash of the merged commit. **Note:** additional commits might be added to the `main` branch by a bot or an automation - we do **NOT** want to tag this commit.
89+
90+
##### Make sure of the following before continuing with the release:
91+
- [ ] CI checks are passing in GH.
92+
93+
- [ ] Create a git tag with the final version set to vX.Y.Z on the main branch. In order to do this:
94+
1. Checkout the commit hash.
95+
`git checkout <commit hash>`
96+
2. Tag the hash with the release version (vX.Y.Z).
97+
`git tag vX.Y.Z`
98+
3. Push the tag to make the final release.
99+
`git push origin vX.Y.Z`
100+
- [ ] Update downstream package dependencies to (>=X.Y.Z) in {package name}.
101+
**Note:** Once the release tag is created, the package is automatically published to internal repositories.
102+
- type: textarea
103+
id: post-release
104+
attributes:
105+
label: Post-release
106+
description: The list of activities to be completed after the release.
107+
placeholder: The steps that must be taken after the release.
108+
value: |
109+
- [ ] Make sure that the package is published to internal repositories (Validated and/or Non-Validated repository).
110+
- [ ] Review and update installation instructions for the package if needed.
111+
- [ ] Make sure internal documentation/documentation catalogs are up to date.
112+
- [ ] Notify the team to start post-release/clean-up activities.
113+
- [ ] Announce the release on ________.
114+
- type: textarea
115+
id: decision-tree
116+
attributes:
117+
label: Decision tree
118+
description: Any decision tree(s) that would aid release management
119+
placeholder: Any decision tree(s) that would aid release management.
120+
value: |
121+
Click [here](https://github.com/insightsengineering/.github/blob/main/.github/ISSUE_TEMPLATE/RELEASE_DECISION_TREE.md) to see the release decision tree.

‎.github/pull_request_template.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Pull Request
2+
3+
<!--- Replace `#nnn` with your issue link for reference. -->
4+
5+
Fixes #nnn
6+
7+
8+
## Checks
9+
10+
- [ ] (Have you updated the changelog.md ?)

‎.github/workflows/pkgdown.yaml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ on:
44
push:
55
branches: [main]
66
pull_request:
7+
types:
8+
- opened
9+
- synchronize
10+
- reopened
11+
- ready_for_review
712
release:
813
types: [published]
914
workflow_dispatch:

0 commit comments

Comments
 (0)