{"id":28206816,"url":"https://github.com/ndrive/capistrano_api_docs_external_git","last_synced_at":"2025-06-11T22:31:06.108Z","repository":{"id":23897933,"uuid":"27277647","full_name":"NDrive/capistrano_api_docs_external_git","owner":"NDrive","description":null,"archived":false,"fork":false,"pushed_at":"2016-01-25T16:42:29.000Z","size":7,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-05-17T11:12:33.305Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NDrive.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-11-28T18:12:59.000Z","updated_at":"2016-01-25T16:42:30.000Z","dependencies_parsed_at":"2022-07-23T08:24:35.685Z","dependency_job_id":null,"html_url":"https://github.com/NDrive/capistrano_api_docs_external_git","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/NDrive/capistrano_api_docs_external_git","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NDrive%2Fcapistrano_api_docs_external_git","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NDrive%2Fcapistrano_api_docs_external_git/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NDrive%2Fcapistrano_api_docs_external_git/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NDrive%2Fcapistrano_api_docs_external_git/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NDrive","download_url":"https://codeload.github.com/NDrive/capistrano_api_docs_external_git/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NDrive%2Fcapistrano_api_docs_external_git/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259354762,"owners_count":22844924,"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":"2025-05-17T11:12:57.359Z","updated_at":"2025-06-11T22:31:06.103Z","avatar_url":"https://github.com/NDrive.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"capistranoApiDocsExternalGit\n=================\n\nAdd tasks to capistrano to a Rails project to work with gem api_docs.\nIt only works with capistrano 3. Older versions until 0.3 works with capistrano 2.\n\nCurrently\n\n* Add documentation files to git\n* Clone documentation repository to tmp folder\n* Copy documentation files from local respository to documentation repository\n* Remove temporary documentation repository\n\nFeel free to fork and to add new tasks.\n\nInstall\n=======\n\nAdd it as a gem:\n\n```ruby\n    gem \"capistrano_api_docs_external_git\"\n```\n\nChange your Capfile:\n\n```ruby\n   require 'capistrano/api_docs_external_git'\n```\n\nAdd if you want change any of this options on your config/deploy.rb:\n```ruby\n    # This one is required\n    # Set Your destination git repository e.g. (git@github.com:guiferrpereira/api-docs.git)\n    set :doc_git_repository, nil\n\n    # Optionals\n    # Set Your destination repository name e.g. \"api-docs\"\n    set :doc_repository_name, \"api-docs\"\n    # Rails Application root folder\n    set :rails_root, Pathname.new(Dir.pwd)\n    # Temporary folder where you want save git repository temporary\n    set :rails_root_tmp_path, fetch(:rails_root).join(\"tmp\")\n    # You should set with ApiDocs.config.docs_path\n    set :api_docs_path, fetch(:rails_root).join(\"doc\", \"api\")\n```\n\nAvailable tasks\n===============\n\n    cap api_docs_external_git:add_files_git  # Add files to documentation git\n    cap api_docs_external_git:clone_repo     # Clone documentation repository to tmp folder\n    cap api_docs_external_git:copy_files     # Copy documentation files from local respository to documentation repository\n    cap api_docs_external_git:remove_files   # Remove documentation repository\n\nExample\n=======\n\n    By default will run after your deploy is finished\n\nTODO\n====\n* Add tests\n\nCopyright (c) 2014 [Guilherme Pereira - NDrive], released under the MIT license","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fndrive%2Fcapistrano_api_docs_external_git","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fndrive%2Fcapistrano_api_docs_external_git","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fndrive%2Fcapistrano_api_docs_external_git/lists"}