Skip to content

Commit 99ab8be

Browse files
committed
Remove release and hotfix overview documentation
General release process documentation has moved to the "developer" section of the Hubverse documentation: hubverse-org/hubDocs#233 This changeset removes that documentation from hubDevs and links to the relocated version (excepting the R release checklist, which remains in hubDevs per hubverse-org/hubDocs#233 (comment)).
1 parent 70f7a7b commit 99ab8be

File tree

6 files changed

+29
-614
lines changed

6 files changed

+29
-614
lines changed

.lintr

-4
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,4 @@ linters: linters_with_defaults(
22
line_length_linter = line_length_linter(120L),
33
commented_code_linter = NULL
44
)
5-
exclusions: list(
6-
"vignettes/hotfixes.qmd", # lintr does not recognise mermaid diagrams
7-
"vignettes/release-process.qmd"
8-
)
95

NEWS.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
1+
# hubDevs 0.1.1.9000
2+
3+
* Remove Hubverse release process overview vignettes (that information has moved
4+
to the [Hubverse documentation](https://hubverse.io/en/latest/developer/).
5+
16
# hubDevs 0.1.1
27

38
* README template now includes release and development version instructions and
49
documentation sites (#12, #18)
510
* README now includes instructions for confirming your GitHub PAT exists and is
6-
available in R.
11+
available in R.
712
* Updated hotfix vignette to use a hubverse-specific scenario (#20)
813

914
# hubDevs 0.1.0

_pkgdown.yml

-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ articles:
77
navbar: ~
88
contents:
99
- "release-process"
10-
- "hotfixes"
1110
- title: "Release/Hotfix/PR Checklist"
1211
navbar: ~
1312
contents:

vignettes/hotfixes.qmd

-268
This file was deleted.

vignettes/release-checklists.qmd

+16-12
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Release Checklists"
2+
title: "R Release Checklists"
33
description: >
44
Reference for how to perform R package releases in the Hubverse
55
vignette: >
@@ -103,6 +103,14 @@ It is important to remember that PRs should focus on _independent features_. If
103103
you want add a new feature and fix a bug, these should be two separate PRs. This
104104
strategy _reduces the size of the PR, making it easier to review_.
105105

106+
::: {.callout-tip title="Tip"}
107+
Review often brings up potential non-blocking features/bug fixes that are
108+
orthogonal to the original PR. In these cases, instead of creating a PR to
109+
merge into the original PR, it's best to **create a new issue from the PR
110+
review** and, after merging, **create a new PR to fix that issue**. This
111+
helps keep disparate bugfixes and features separate.
112+
:::
113+
106114
- [ ] Create a new branch from main called `<initials>/<feature>/<issue>`.
107115
(e.g.
108116
[`ak/change-check-fail-class-and-print/111`](https://github.com/hubverse-org/hubValidations/pull/114),
@@ -118,21 +126,17 @@ Caveats:
118126

119127
1. You should not change the development version number, **unless
120128
there are important feature changes that are required by an upstream
121-
package** (see [more about the development version number](release-process.html#dev)).
122-
2. Review often brings up potential non-blocking features/bug fixes that are
123-
orthogonal to the original PR. In these cases, instead of creating a PR to
124-
merge into the original PR, it's best to **create a new issue from the PR
125-
review** and, after merging, **create a new PR to fix that issue**. This
126-
helps keep disparate bugfixes and features separate.
127-
3. If introducing **breaking changes**, you must not merge into `main` until
129+
package** (see [more about the development version number](https://hubverse.io/en/latest/developer/release-process.html#versioning)).
130+
2. If introducing **breaking changes**, you must not merge into `main` until
128131
these changes have been tested and communicated with the community.
129132

130133
## Hotfix Checklist
131134

132135
A hotfix is a bug fix that is independent from in-development features and needs
133-
to be deployed within a day. Details on hotfixes can be found in
134-
`vignette("hotfixes", package = "hubDevs")`. To patch and release a hotfix,
135-
follow this protocol:
136+
to be deployed within a day. Refer to the Hubverse documentation for
137+
[details about hotfixes](https://hubverse.io/en/latest/developer/hotfix.html).
138+
139+
To patch and release a hotfix, follow this protocol:
136140

137141
- [ ] Create a new branch from the latest tag using `<author>/hotfix/<issue>` (MUST be this pattern)
138142
```sh
@@ -147,7 +151,7 @@ follow this protocol:
147151
(znk/hotfix/143)$ git push -u origin znk/hotfix/143 # push the hotfix
148152
```
149153
- [ ] Create a pull request, get a review from another hubverse developer, and confirm that checks pass against the released versions of the packages **(Do not merge yet)**
150-
- [ ] Update the NEWS and bump the [patch version](release-process.html#patch) in the DESCRIPTION
154+
- [ ] Update the NEWS and bump the [patch version](https://hubverse.io/en/latest/developer/release-process.html#patch) in the DESCRIPTION
151155
- [ ] Release from the hotfix branch
152156
```sh
153157
(znk/hotfix/143)$ git commit -m 'bump version to 0.14.1'

0 commit comments

Comments
 (0)