diff --git a/search.json b/search.json
index daf1ab9..9d51bd7 100644
--- a/search.json
+++ b/search.json
@@ -39,21 +39,14 @@
"href": "content/cicdworkflows-enhanced/posts/validate/validate.html#why-should-i-use-this",
"title": "theValidator",
"section": "Why should I use this?",
- "text": "Why should I use this?\nAs a codebase grows, it becomes more likely you will end up with a number of links in your documentation. These links can over time stop working - and often you wonβt know till a user flags your links or broken.\nThis gh-action lets you stay on top of broken links, by actively scanning for them."
+ "text": "Why should I use this?\nValidation is not a fixed term, and it is strongly recommended to make yourself aware of the work of the R Validation Hub (https://www.pharmar.org/), including the regulatory repo project.\nWhen using an R package, it is important to know that what the documentation claims the package does is tested, and these tests pass on the environment you will be using. This gh-action generates a generic report, that takes the documentation and links it to the unit tests, and records how the the tests performed against a specific R environment.\nThe aim here is to who in a pan-company way to document the relationship between documentation and tests. Before using internally, you would need to 1) confirm the documentation is well written, 2) the unit tests are sufficient to test that documentation and 3) you are assessing against the actual environments you use internally."
},
{
"objectID": "content/cicdworkflows-enhanced/posts/validate/validate.html#how-do-i-set-it-up",
"href": "content/cicdworkflows-enhanced/posts/validate/validate.html#how-do-i-set-it-up",
"title": "theValidator",
"section": "How do I set it up?",
- "text": "How do I set it up?\nBelow is an example of using this gh-action whenever someone tries to make PR into your main or devel branch.\n---\nname: Docs π\n\non:\n push:\n branches:\n - main\n - devel\n pull_request:\n branches:\n - main\n - devel\n\njobs:\n links:\n name: Links\n uses: pharmaverse/admiralci/.github/workflows/links.yml@main\n if: github.event_name == 'pull_request'"
- },
- {
- "objectID": "content/cicdworkflows-enhanced/posts/validate/validate.html#the-deets",
- "href": "content/cicdworkflows-enhanced/posts/validate/validate.html#the-deets",
- "title": "theValidator",
- "section": "The deets",
- "text": "The deets\nThis gh-action uses lychee. If you need to prevent false positive deadlinks stopping the process, you can use a .lycheeignore file. There is an example of this file from admiral here."
+ "text": "How do I set it up?\nBelow is an example of using this gh-action when a release is made.\n---\nname: R Package Validation report\n\non: # Run this action when a release is published\n release:\n types: [published]\n\njobs:\n r-pkg-validation:\n name: Create report π\n runs-on: ubuntu-latest\n container:\n image: rocker/verse:4.1.1\n # Set Github token permissions\n env:\n GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}\n permissions:\n contents: write\n packages: write\n deployments: write\n steps:\n - name: Checkout repo π\n uses: actions/checkout@v3\n\n - name: Build report π\n id: validation\n uses: insightsengineering/thevalidatoR@main\n # see parameters above for custom templates and other formats\n\n # Upload the validation report to the release\n - name: Upload report to release πΌ\n if: success()\n uses: svenstaro/upload-release-action@v2\n with:\n file: ${{ steps.validation.outputs.report_output_filename }}\n asset_name: ${{ steps.validation.outputs.report_output_filename }}\n repo_token: ${{ secrets.GITHUB_TOKEN }}\n tag: ${{ github.ref }}\n overwrite: false"
},
{
"objectID": "content/cicdworkflows-minimum/posts/code-coverage.html",
diff --git a/sitemap.xml b/sitemap.xml
index 4aa6c52..fe4791f 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -2,70 +2,70 @@
https://phuse-org.github.io/devops/content/cicdworkflows-recommend/posts/check-links/check-links.html
- 2023-12-29T08:55:27.306Z
+ 2023-12-29T09:11:53.464Z
https://phuse-org.github.io/devops/content/cicdworkflows-enhanced/posts/validate/validate.html
- 2023-12-29T08:55:26.510Z
+ 2023-12-29T09:11:52.696Z
https://phuse-org.github.io/devops/content/cicdworkflows-minimum/posts/code-coverage.html
- 2023-12-29T08:55:25.726Z
+ 2023-12-29T09:11:51.888Z
https://phuse-org.github.io/devops/content/cicdworkflows-minimum/posts/pkgdown.html
- 2023-12-29T08:55:24.706Z
+ 2023-12-29T09:11:50.312Z
https://phuse-org.github.io/devops/contact.html
- 2023-12-29T08:55:23.622Z
+ 2023-12-29T09:11:49.108Z
https://phuse-org.github.io/devops/post/posts/gh-actions.html
- 2023-12-29T08:55:22.586Z
+ 2023-12-29T09:11:48.068Z
https://phuse-org.github.io/devops/post/index.html
- 2023-12-29T08:55:22.070Z
+ 2023-12-29T09:11:47.568Z
https://phuse-org.github.io/devops/meetings/minutes/2023-06-23.html
- 2023-12-29T08:55:21.414Z
+ 2023-12-29T09:11:46.948Z
https://phuse-org.github.io/devops/meetings/index.html
- 2023-12-29T08:55:20.538Z
+ 2023-12-29T09:11:46.104Z
https://phuse-org.github.io/devops/meetings/minutes/2023-08-11.html
- 2023-12-29T08:55:21.110Z
+ 2023-12-29T09:11:46.656Z
https://phuse-org.github.io/devops/about.html
- 2023-12-29T08:55:21.718Z
+ 2023-12-29T09:11:47.224Z
https://phuse-org.github.io/devops/post/posts/external-resources.html
- 2023-12-29T08:55:22.330Z
+ 2023-12-29T09:11:47.816Z
https://phuse-org.github.io/devops/index.html
- 2023-12-29T08:55:23.386Z
+ 2023-12-29T09:11:48.868Z
https://phuse-org.github.io/devops/content/cicdworkflows-minimum/index.html
- 2023-12-29T08:55:24.078Z
+ 2023-12-29T09:11:49.588Z
https://phuse-org.github.io/devops/content/cicdworkflows-minimum/posts/r-cmd-check/r-cmd-check.html
- 2023-12-29T08:55:25.174Z
+ 2023-12-29T09:11:50.780Z
https://phuse-org.github.io/devops/content/cicdworkflows-enhanced/index.html
- 2023-12-29T08:55:26.066Z
+ 2023-12-29T09:11:52.228Z
https://phuse-org.github.io/devops/content/cicdworkflows-recommend/index.html
- 2023-12-29T08:55:26.838Z
+ 2023-12-29T09:11:53.024Z