Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove release and hotfix overview documentation #31

Merged
merged 2 commits into from
Feb 10, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions .lintr
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,4 @@ linters: linters_with_defaults(
line_length_linter = line_length_linter(120L),
commented_code_linter = NULL
)
exclusions: list(
"vignettes/hotfixes.qmd", # lintr does not recognise mermaid diagrams
"vignettes/release-process.qmd"
)

7 changes: 6 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
# hubDevs 0.1.1.9000

* Remove Hubverse release process overview vignettes (that information has moved
to the [Hubverse documentation](https://hubverse.io/en/latest/developer/)).

# hubDevs 0.1.1

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

# hubDevs 0.1.0
Expand Down
1 change: 0 additions & 1 deletion _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ articles:
navbar: ~
contents:
- "release-process"
- "hotfixes"
- title: "Release/Hotfix/PR Checklist"
navbar: ~
contents:
Expand Down
268 changes: 0 additions & 268 deletions vignettes/hotfixes.qmd

This file was deleted.

28 changes: 16 additions & 12 deletions vignettes/release-checklists.qmd
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Release Checklists"
title: "R Release Checklists"
description: >
Reference for how to perform R package releases in the Hubverse
vignette: >
Expand Down Expand Up @@ -103,6 +103,14 @@ It is important to remember that PRs should focus on _independent features_. If
you want add a new feature and fix a bug, these should be two separate PRs. This
strategy _reduces the size of the PR, making it easier to review_.

::: {.callout-tip title="Tip"}
Review often brings up potential non-blocking features/bug fixes that are
orthogonal to the original PR. In these cases, instead of creating a PR to
merge into the original PR, it's best to **create a new issue from the PR
review** and, after merging, **create a new PR to fix that issue**. This
helps keep disparate bugfixes and features separate.
:::

- [ ] Create a new branch from main called `<initials>/<feature>/<issue>`.
(e.g.
[`ak/change-check-fail-class-and-print/111`](https://github.com/hubverse-org/hubValidations/pull/114),
Expand All @@ -118,21 +126,17 @@ Caveats:

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

## Hotfix Checklist

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

To patch and release a hotfix, follow this protocol:

- [ ] Create a new branch from the latest tag using `<author>/hotfix/<issue>` (MUST be this pattern)
```sh
Expand All @@ -147,7 +151,7 @@ follow this protocol:
(znk/hotfix/143)$ git push -u origin znk/hotfix/143 # push the hotfix
```
- [ ] 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)**
- [ ] Update the NEWS and bump the [patch version](release-process.html#patch) in the DESCRIPTION
- [ ] Update the NEWS and bump the [patch version](https://hubverse.io/en/latest/developer/release-process.html#patch) in the DESCRIPTION
- [ ] Release from the hotfix branch
```sh
(znk/hotfix/143)$ git commit -m 'bump version to 0.14.1'
Expand Down
Loading
Loading