Skip to content

Commit

Permalink
Merge pull request #108 from fishR-Core-Team/dev
Browse files Browse the repository at this point in the history
Preparing v0.9.5 (for CRAN)
  • Loading branch information
droglenc committed Aug 26, 2023
2 parents 50e3be5 + a24a51e commit 27a341a
Show file tree
Hide file tree
Showing 89 changed files with 505 additions and 397 deletions.
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/release-prep-template.md
Expand Up @@ -8,7 +8,7 @@ assignees: ''

---

Below are the steps used to prepare `FSAdata` for submission to CRAN. The steps should generally be followed in order (i.e., don't move to the next step without success at the current step). It is common to have to repeat some previous steps if an error/warning occurs at a subsequent step (in my experience, this most often happens after checking on the development version of R when using R-winbuilder).
Below are the steps used to prepare `FSA` for submission to CRAN. The steps should generally be followed in order (i.e., don't move to the next step without success at the current step). It is common to have to repeat some previous steps if an error/warning occurs at a subsequent step (in my experience, this most often happens after checking on the development version of R when using R-winbuilder).

It is worth noting that this whole process can take 2-3 hours (or more depending on internet speed) with significant "waiting time" for checks and builds.

Expand All @@ -20,7 +20,7 @@ It is worth noting that this whole process can take 2-3 hours (or more depending
- [ ] Update all packages, especially those that `FSA` and `FSAdata` depend on.

### 1 - `dev` branch (at local repo)
- [ ] Ensure no outstanding issues in [checks on CRAN](https://cran.r-project.org/web/checks/check_results_FSAdata.html)
- [ ] Ensure no outstanding issues in [checks on CRAN](https://cran.r-project.org/web/checks/check_results_FSA.html)
- [ ] Ensure that all branches emanating from `dev` have been appropriately merged to `dev` via pull request.
- [ ] Update `Version` field in **DESCRIPTION** (next number up without the .9000 on the end).
- [ ] Update `Date` field in **DESCRIPTION**.
Expand All @@ -38,7 +38,7 @@ It is worth noting that this whole process can take 2-3 hours (or more depending

### 3 - `dev` branch (at remote GitHub repo)
- [ ] Ensure that "R-CMD-check.yaml" [GitHub action](https://github.com/fishR-Core-Team/FSA/actions) was successful for the `dev` branch (this should run automatically with the push to `dev`, but will take some time to finish (possibly >20 mins)). If not successful then address issues and repeat as much above as necessary.
- [ ] Create a pull-request asking to merge the `dev` branch to the `main` branch. Ask someone from the FSAdata team to review the request. [*Ensure that all checks were successfully completed.*]
- [ ] Create a pull-request asking to merge the `dev` branch to the `main` branch. Ask someone from the FSA team to review the request. [*Ensure that all checks were successfully completed.*]

### 4 - `main` branch (at remote GitHub repo)
- [ ] Merge approved (assumingly) pull request from `dev` branch.
Expand All @@ -53,11 +53,11 @@ It is worth noting that this whole process can take 2-3 hours (or more depending
- [ ] Check all three boxes (make sure that your answers are truthful) and press `Upload the Package to CRAN`. You should get a confirmation e-mail almost immediately (no need to respond to this).

### 6 - `main` branch (at remote GitHub repo)
- [ ] Create a [new release](https://github.com/fishR-Core-Team/FSAdata/releases). `Tag` should relate to the version number and the `Title` should state that the version number is being released to CRAN (see past examples). Make sure that the `Target` is set to `Main`. Add an optional `Description` if desired. Drag and drop the source (.tar.gz) and binary (.zip) files created in the previous step on to the `Attach binaries ...` box. Press `Publish Release`.
- [ ] Create a [new release](https://github.com/fishR-Core-Team/FSA/releases). `Tag` should relate to the version number and the `Title` should state that the version number is being released to CRAN (see past examples). Make sure that the `Target` is set to `Main`. Add an optional `Description` if desired. Drag and drop the source (.tar.gz) and binary (.zip) files created in the previous step on to the `Attach binaries ...` box. Press `Publish Release`.

### 7 - `dev` branch (at remote GitHub repo)
- [ ] Create a pull-request asking to merge the `main` branch to the `dev` branch. This is needed after merging `dev` to `main` above so that the two branches are synced.
- [ ] Merge pull request from `main` branch (*OK to do this without getting approval from FSAdata team member*). *Note that the `dev` branch will say it is "1 commit ahead of `main`" after this step.*
- [ ] Merge pull request from `main` branch (*OK to do this without getting approval from FSA team member*). *Note that the `dev` branch will say it is "1 commit ahead of `main`" after this step.*

### 8 - `dev` branch (at local repo)
- [ ] Fetch the remote `dev` branch and pull the updates to local `dev` branch so that the local and remote `dev` branches are the same.
Expand Down
4 changes: 2 additions & 2 deletions DESCRIPTION
@@ -1,6 +1,6 @@
Package: FSA
Version: 0.9.4
Date: 2023-2-1
Version: 0.9.5
Date: 2023-8-25
Title: Simple Fisheries Stock Assessment Methods
Description: A variety of simple fish stock assessment methods.
Authors@R: c(
Expand Down
3 changes: 3 additions & 0 deletions NEWS.md
@@ -1,3 +1,6 @@
# FSA 0.9.5
* Fixed FSA-package \alias problem using the "automatic approach" (i.e., adding a "_PACKAGE" line to FSA.R) suggested in an e-mail from Kurt Hornik on 19-Aug-2023.

# FSA 0.9.4
* Changes related to moving to fishR-Core-Team
* Updated sticker.
Expand Down
5 changes: 3 additions & 2 deletions R/FSA.R
Expand Up @@ -15,8 +15,9 @@
#'
#' @references Ogle, D.H. 2016. \href{https://fishr-core-team.github.io/fishR/pages/books.html#introductory-fisheries-analyses-with-r}{Introductory Fisheries Analyses with R}. Chapman & Hall/CRC, Boca Raton, FL.
#'
#' @docType package
#'
#' @name FSA
#'
#' @keywords internal
"_PACKAGE"

NULL
10 changes: 10 additions & 0 deletions cran-comments/cran-comments-v0_9_5.md
@@ -0,0 +1,10 @@
* This updates the existing FSA package on CRAN with minor fixes and correction for package alias per e-mail from Kurt Hornik on 19-Aug-23.

## Notes
* There may be a note about "fishR" being misspelled in the description. This is not a misspelling.

## Testing Environments
* My Windows machine.
* Win Builder -- old-release, release, and development.
* Mac Builder
* GitHub Action (R-CMD-check.yaml)
2 changes: 1 addition & 1 deletion docs/LICENSE-text.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions docs/authors.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 27a341a

Please sign in to comment.