{"id":18174348,"url":"https://github.com/insightsengineering/r-pkgdown-multiversion","last_synced_at":"2025-10-28T23:32:48.559Z","repository":{"id":37630509,"uuid":"418905033","full_name":"insightsengineering/r-pkgdown-multiversion","owner":"insightsengineering","description":"Github Action to generate multiple versions of pkgdown docs for R packages","archived":false,"fork":false,"pushed_at":"2025-01-09T15:16:51.000Z","size":97,"stargazers_count":5,"open_issues_count":2,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-24T14:17:38.778Z","etag":null,"topics":["github-actions","pkgdown","r"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/r-pkgdown-multi-version-docs","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/insightsengineering.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"custom":["https://pharmaverse.org"]}},"created_at":"2021-10-19T12:00:45.000Z","updated_at":"2025-01-09T15:15:02.000Z","dependencies_parsed_at":"2024-10-22T20:39:19.402Z","dependency_job_id":null,"html_url":"https://github.com/insightsengineering/r-pkgdown-multiversion","commit_stats":{"total_commits":36,"total_committers":8,"mean_commits":4.5,"dds":0.25,"last_synced_commit":"5d818561709f56fe1980139242594edcebd94a2a"},"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/insightsengineering%2Fr-pkgdown-multiversion","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/insightsengineering%2Fr-pkgdown-multiversion/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/insightsengineering%2Fr-pkgdown-multiversion/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/insightsengineering%2Fr-pkgdown-multiversion/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/insightsengineering","download_url":"https://codeload.github.com/insightsengineering/r-pkgdown-multiversion/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248613512,"owners_count":21133525,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-actions","pkgdown","r"],"created_at":"2024-11-02T16:02:50.029Z","updated_at":"2025-10-28T23:32:48.472Z","avatar_url":"https://github.com/insightsengineering.png","language":"Python","readme":"\u003c!-- BEGIN_ACTION_DOC --\u003e\n\n# R pkgdown Multi Version docs\n\nGitHub Action to generate multiple versions of [`pkgdown`](https://pkgdown.r-lib.org/) docs for R packages.\n\nThis GitHub Actions works under the following assumptions:\n\n- R package documentation is generated by the R function [`pkgdown::build_site`](https://pkgdown.r-lib.org/reference/build_site.html)\n- Documentation is published to the `gh-pages` branch of the package repository and GitHub Pages is enabled at the root level of the branch\n- The version of `pkgdown` used to generate the documentation is `\u003e= v2.0.0`\n- The `pkgdown` documentation uses Bootstrap 5\n- The `URL` field in the package DESCRIPTION file contains a reference to the pkgdown site URL (see step 1 [here](https://pkgdown.r-lib.org/articles/pkgdown.html#promoting))\n\nAn example of the output of the action can be seen below:\n\n![Screenshot with example output](example.png)\n\n## Description\n\nGenerates multisite R documentation created with pkgdown.\n\n## Action Type\n\nComposite\n\n## Author\n\nInsights Engineering\n\n## Inputs\n\n- `path`:\n\n  _Description_: Path to package's root\n\n  _Required_: `false`\n\n  _Default_: `.`\n\n- `default-landing-page`:\n\n  _Description_: The default branch or tag on gh-pages that corresponds to the landing page.\n  For instance, if your root index page on gh-pages is built using the 'main'\n  branch, then the root page of the site will correspond to this page.\n  If 'latest-tag' is selected, then the latest version will become the default.\n\n  _Required_: `false`\n\n  _Default_: `main`\n\n- `branches-or-tags-to-list`:\n\n  _Description_: Which branches or tags should be listed under the 'Versions' dropdown menu on the landing page? This input should be a regular expression in R.\n\n  _Required_: `false`\n\n  _Default_: `^main$|^devel$|^prerelease$|^latest-tag$|^release-candidate$|^develop$|^v([0-9]+\\.)?([0-9]+\\.)?([0-9]+)|^v([0-9]+\\.)?([0-9]+\\.)?([0-9]+)(-rc[0-9]+)$`\n\n- `refs-order`:\n\n  _Description_: The order in which refs should appear in the drop-down list. Versions not in the vector\n  will appear below refs listed here.\n  If docs have never been generated for the ref, the ref will not appear in the\n  drop-down. Similarly, if docs have been generated for the ref, but the ref is not\n  listed in the vector, it will not appear in the drop-down.\n  Example (the refs on the list should be separated by space):\n  main devel prerelease latest-tag\n\n  _Required_: `false`\n\n  _Default_: `main devel prerelease latest-tag`\n\n- `latest-tag-alt-name`:\n\n  _Description_: An alternate name for the 'latest-tag' item\n\n  _Required_: `false`\n\n  _Default_: `\"\"`\n\n- `release-candidate-alt-name`:\n\n  _Description_: An alternate name for the 'release-candidate' item\n\n  _Required_: `false`\n\n  _Default_: `\"\"`\n\n## Outputs\n\nNone\n\n\u003c!-- END_ACTION_DOC --\u003e\n","funding_links":["https://pharmaverse.org"],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finsightsengineering%2Fr-pkgdown-multiversion","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finsightsengineering%2Fr-pkgdown-multiversion","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finsightsengineering%2Fr-pkgdown-multiversion/lists"}