From 6dcc48d3ca99044ad32e9918e89c32b9a9967902 Mon Sep 17 00:00:00 2001 From: Thomas Bouffard <27200110+tbouffard@users.noreply.github.com> Date: Tue, 7 Sep 2021 14:41:58 +0200 Subject: [PATCH] [INFRA] Integrate feedback of the first release (#48) Documentation for CRAN submission: simplify and remove screenshots Screenshots increase the source package size (we could ignore the files in RbuildIgnore) and are not useful: there is enough information provided by the linked contents. Source package content fixes - DESCRIPTION: title in title case - Content: add all md files and the doc directory The README.md file generates warnings because of unreachable links (contributing.md not in the package) Do not package the doc folder: only needed for the README.md file, non standard folder These changes will be reviewed when working on the documentation The GitHub worklow now builds the source package and run checks on it as done during the CRAN submission to detect errors earlier --- .Rbuildignore | 3 ++- .github/workflows/R-CMD-check.yaml | 34 +++++++++++++++++++++++++++-- CONTRIBUTING.md | 19 +++++++++------- DESCRIPTION | 2 +- doc/cran-submitting.png | Bin 63589 -> 0 bytes doc/r-studio-binary-build.png | Bin 63559 -> 0 bytes 6 files changed, 46 insertions(+), 12 deletions(-) delete mode 100644 doc/cran-submitting.png delete mode 100644 doc/r-studio-binary-build.png diff --git a/.Rbuildignore b/.Rbuildignore index 09cfdba..069b3ea 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -3,5 +3,6 @@ ^.*\.iml$ ^.*\.Rproj$ ^\.Rproj\.user$ -^CONTRIBUTING\.md$ +^.*\.md$ +^doc$ ^LICENSE$ diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml index 0b5b742..0662c3d 100644 --- a/.github/workflows/R-CMD-check.yaml +++ b/.github/workflows/R-CMD-check.yaml @@ -80,7 +80,37 @@ jobs: - name: Upload check results if: failure() - uses: actions/upload-artifact@main + uses: actions/upload-artifact@v2 with: - name: ${{ matrix.config.os }}-r${{ matrix.config.r }}-results + name: ${{ matrix.config.os }}-r${{ matrix.config.r }}-check-results path: check + +# ###################################################################################################################### +# Package submission checks +# https://cran.r-project.org/web/packages/policies.html#Submission +# ###################################################################################################################### + - name: Build the source package + run: | + R CMD build . + ls -la + - name: Upload the source package + uses: actions/upload-artifact@v2 + with: + name: ${{ matrix.config.os }}-r${{ matrix.config.r }}-source-package + path: bpmnVisualization_*.tar.gz + + + # Sets up LaTeX with tinytex, for PDF generation + # not needed before as the checks on the repo sources are done with --no-manual + - uses: r-lib/actions/setup-tinytex@v1 + + - name: Check the source package + id: source_package_checks + run: R CMD check --as-cran bpmnVisualization_*.tar.gz + + - name: Upload source package check results + if: ${{ failure() && steps.source_package_checks.outcome == 'failure' }} + uses: actions/upload-artifact@v2 + with: + name: ${{ matrix.config.os }}-r${{ matrix.config.r }}-source-package-check-results + path: bpmnVisualization.Rcheck diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9be73b7..af281bd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -149,14 +149,17 @@ Create a new PR and merge it, if the version in the [DESCRIPTION](./DESCRIPTION) - Pull the new version created by the release workflow: `git pull origin` - Ensure you are on the last tag locally: `git checkout vX.Y.Z` -- Open the project in the R Studio -- On the **Build** tab, click on **More** > **Build Binary Package** -
- -- Go to the parent folder of the project. You should find a file named like `bpmnVisualization_X.Y.Z.tgz`. -- Fill all the fields of this [web form](https://xmpalantir.wu.ac.at/cransubmit/), and load `bpmnVisualization_X.Y.Z.tgz` file. -- Submit - +- Build the source package. Please read [the CRAN Submission policies first](https://cran.r-project.org/web/packages/policies.html#Submission) + - Solution 1: Build the source package with RStudio + - Open the project in RStudio + - On the **Build** tab, click on **More** > **Build Source Package** + - Go to the parent folder of the project. You should find a file named like `bpmnVisualization_X.Y.Z.tgz`. + - Solution 2. + - from the project directory, run `R CMD build . + - You should find a file named like `bpmnVisualization_X.Y.Z.tgz` in the project directory. +- Do the actual submission + - Fill all the fields of this [web form](https://xmpalantir.wu.ac.at/cransubmit/), and load `bpmnVisualization_X.Y.Z.tgz` file. + - Submit ### Communicate about the release diff --git a/DESCRIPTION b/DESCRIPTION index 268dab8..ff1afad 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: bpmnVisualization Type: Package -Title: Visualize process execution data on BPMN diagrams +Title: Visualize Process Execution Data on BPMN Diagrams Version: 0.1.0 Authors@R: c(person("Celine", "Souchet", role = c("aut", "cre"), email = "celine.souchet@bonitasoft.com"), person("Thomas", "Bouffard", role = "aut")) diff --git a/doc/cran-submitting.png b/doc/cran-submitting.png deleted file mode 100644 index c4308875d747e98691d26911041588bef21d2807..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 63589 zcmcG$c{tSX-v?SM5kjR=$&yN021&>kLLy6uhOs6j`-rhki!E!5t!&vTd)BdK854>@ zhO&i*u})@eW0*Pje4q1se!p|B>s-%sopYVPY6j!;xj*;)e!sT2m&S&=Tt`kH*|%>W zm)@Pg7rh2`w@YHH*UU9&gLZ%9>im6@|Gk_Z1dR(;N!w_wlPxd
zCXUeu5oL2JrzLQw+U|;ULQ5V5HdXnZD)bwRxmQC-Ul8S8A4<(rHnkH bGrfE0VF&IDwF)qZ_qh~qi3hb1NR5Q5B{;_d2Iqw
zhCPUD{{o%0BgP+b?EHJI((!RgnfLlcS>NrEKUx&8oGTz~wi9w;ik0w19UX(1lu?K?
zOp$s9l;Nmvf56gwN29(Qko60=w|W2@UsDE|k9vMoI2wKjCtD>10?ZF}`r#YM-cj@e
z;*9hMH%OOP!6Ek<&SNl0VDhAqfZ;xrF9fW7Xx_CIDh}1WyTRb4;eInf$g1;!1kmv&
z@1e642a9JN)&ZTzTxSSt(_9^^
zkMv_6f+!#zGDxW{@B&~)cQ8J^?GTjrEU2*Ihv*-Xi4&BK{|0y@93LZCL%{K$DUh4e
z$4qJgemWE-BtO1!Wf=r~jx73ugBA}H!cF 4()W4wO{1sro(W;|o6C8tS3dJ6*-MQ%Tj^|ejleQd
z;L*RCN5T{OQvtVvhYVP&ep$FQ)KUZ4*CzgRdxoxdW0;HjTNvoD