{"id":18046671,"url":"https://github.com/ltla/trojanbookbuilder","last_synced_at":"2025-04-05T04:25:02.969Z","repository":{"id":82716862,"uuid":"286342247","full_name":"LTLA/TrojanBookBuilder","owner":"LTLA","description":"Sneak books onto the Bioconductor build system with a trojan package.","archived":false,"fork":false,"pushed_at":"2020-10-04T18:44:39.000Z","size":23,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-10T12:29:40.213Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LTLA.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-08-10T00:42:35.000Z","updated_at":"2020-10-04T18:44:41.000Z","dependencies_parsed_at":null,"dependency_job_id":"f28bb20e-d036-46ad-8290-897460cb4dd0","html_url":"https://github.com/LTLA/TrojanBookBuilder","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LTLA%2FTrojanBookBuilder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LTLA%2FTrojanBookBuilder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LTLA%2FTrojanBookBuilder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LTLA%2FTrojanBookBuilder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LTLA","download_url":"https://codeload.github.com/LTLA/TrojanBookBuilder/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247288326,"owners_count":20914344,"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":[],"created_at":"2024-10-30T19:08:26.899Z","updated_at":"2025-04-05T04:25:02.941Z","avatar_url":"https://github.com/LTLA.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Trojan Book Packages for the BBS\n\n## Overview\n\nThis is a GitHub Action to construct a \"trojan package\" to sneak books into the Bioconductor Build System (BBS).\nTo use it, you will need:\n\n- A GitHub repository containing a **bookdown** book, compilable by running `bookdown::render_book` in its top-level directory.\nThis should have a `DESCRIPTION` file describing all the necessary dependencies.\n- A GitHub repository containing the trojan R package, following the Bioconductor requirements for a workflow package.\nNon-book dependencies should be listed in `OriginalDepends:`, `OriginalImports:` or `OriginalSuggests:`.\n\n## Effects\n\nThis action will \"transplant\" the book contents into the `vignettes/` subdirectory of the trojan.\nCombined with appropriate `Makefile` instructions, this can trick the BBS into compiling the book along with the usual vignettes.\nThe subsequent tarball will contain the compiled book for downloading and posting online.\n\nThe book's dependencies are added to the trojan's `DESCRIPTION` so that the correct packages are available.\nNote that this will wipe any existing dependencies, so anything important should instead be listed in the `Original*` fields.\nThe version and date are also bumped if there were any changes in the trojan's contents due to these actions.\n\n## Deployment\n\nThis action should be used in a scheduled GHA workflow in the trojan repository:\n\n```yaml\n      - name: Transplant book contents\n        uses: LTLA/TrojanBookBuilder@master\n        with:\n          book: Bioconductor/OrchestratingSingleCellAnalysis\n```\n\nIt should be used after [`checkout`](https://github.com/actions/checkout) whereupon it will make changes to the workspace;\nsuch changes can be committed with a subsequent `git add -A` step.\nAn additional step can then be used to push changes to the Bioconductor Git servers, \ngiven a secret containing an appropriate private key.\nReaders are referred to the GitHub Action at https://github.com/LTLA/OrchestratingSingleCellAnalysisBook as a working example.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fltla%2Ftrojanbookbuilder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fltla%2Ftrojanbookbuilder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fltla%2Ftrojanbookbuilder/lists"}