[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

Author: tbouffard

.Rbuildignore

@@ -3,5 +3,6 @@
 ^.*\.iml$
 ^.*\.Rproj$
 ^\.Rproj\.user$
-^CONTRIBUTING\.md$
+^.*\.md$
+^doc$
 ^LICENSE$

.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

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**
-<p align="center"><img title="Build Binary Package" src="./doc/r-studio-binary-build.png" alt="Build Binary Package"></p>
-
-- 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
-<p align="center"><img title="Submitting to CRAN" src="./doc/cran-submitting.png" alt="Submitting to CRAN"></p>
+- 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
 

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"))