{"id":15461459,"url":"https://github.com/ibnesayeed/setup-ipfs","last_synced_at":"2025-05-05T21:33:58.427Z","repository":{"id":38301759,"uuid":"263160880","full_name":"ibnesayeed/setup-ipfs","owner":"ibnesayeed","description":"A GitHub Action to install and initialize IPFS","archived":false,"fork":false,"pushed_at":"2023-09-25T15:34:42.000Z","size":1027,"stargazers_count":21,"open_issues_count":9,"forks_count":6,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-25T19:35:29.457Z","etag":null,"topics":["actions","cicd","github-actions","github-workflow","ipfs","ipfs-installation","ipfs-setup","javascript","javascript-action","nodejs","testing"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/ibnesayeed.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":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-05-11T21:20:45.000Z","updated_at":"2025-04-16T03:38:45.000Z","dependencies_parsed_at":"2024-01-05T20:46:18.891Z","dependency_job_id":"aa63ef2c-c691-46c4-aaea-43e6db2d0dee","html_url":"https://github.com/ibnesayeed/setup-ipfs","commit_stats":{"total_commits":162,"total_committers":3,"mean_commits":54.0,"dds":"0.24691358024691357","last_synced_commit":"646ad23528433d7712147682090744ba7a636c2c"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ibnesayeed%2Fsetup-ipfs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ibnesayeed%2Fsetup-ipfs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ibnesayeed%2Fsetup-ipfs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ibnesayeed%2Fsetup-ipfs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ibnesayeed","download_url":"https://codeload.github.com/ibnesayeed/setup-ipfs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251177709,"owners_count":21548101,"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":["actions","cicd","github-actions","github-workflow","ipfs","ipfs-installation","ipfs-setup","javascript","javascript-action","nodejs","testing"],"created_at":"2024-10-01T23:41:57.243Z","updated_at":"2025-05-05T21:33:58.393Z","avatar_url":"https://github.com/ibnesayeed.png","language":"JavaScript","readme":"# IPFS Setup Action\n\nA GitHub Action to install and initialize [go-ipfs](https://github.com/ipfs/go-ipfs) to run an instance of [InterPlanetary File System (IPFS)](https://ipfs.io/) in all supported runner platforms.\nThis action aims to provide an environment to test DApps that rely on IPFS.\n\n\n## Inputs\n\nThis action automatically detects runner platform features like the operating system and the processor architecture.\n\n### `ipfs_version`\n\nIPFS version, automatically resolved to the best matching [released binary](https://dist.ipfs.io/go-ipfs/versions) as per the [SemVer format](https://semver.org/) (default: `0.6`).\n\n### `run_daemon`\n\nWhether to start IPFS service daemon after installation and initialization (default: `false`).\n\n\n## Outputs\n\nThe setup process sets some output variables to be utilized in any succeeding steps.\n\n### `resolved_ipfs_version`\n\nLatest matching SemVer IPFS version installed.\n\n### `ipfs_download_url`\n\nUtilized IPFS distribution download URL.\n\n### `peer_id`\n\nIdentity of the peer as reported on initialization.\n\n### `welcome_ref`\n\nHash of the Welcome object containing `readme`, `help`, and other files.\n\n\n## Example usage\n\nA simple usage in `jobs.\u003cjob_id\u003e.steps` with default latest IPFS version:\n\n```yml\n- uses: ibnesayeed/setup-ipfs@master\n```\n\nSetting up a custom IPFS version (e.g., latest patch of IPFS `0.4.x`):\n\n```yml\n- uses: ibnesayeed/setup-ipfs@master\n  with:\n    ipfs_version: ^0.4\n```\n\nAutomatically booting the IPFS API service after installation and initialization:\n\n```yml\n- uses: ibnesayeed/setup-ipfs@master\n  with:\n    run_daemon: true\n```\n\nA comprehensive example with matrix setup to test against various virsions of IPFS on various platforms:\n\n```yml\njobs:\n  test-in-matrix:\n    strategy:\n      matrix:\n        os:\n          - ubuntu-latest\n          - macos-latest\n          - windows-latest\n        ipfs:\n          - 0.4\n          - 0.5\n          - 0.6\n    runs-on: ${{ matrix.os }}\n    name: Test on ${{ matrix.os }} with IPFS ${{ matrix.ipfs }}\n    steps:\n      - name: Set up IPFS ${{ matrix.ipfs }}\n        uses: ibnesayeed/setup-ipfs@master\n        id: ipfs_setup\n        with:\n          ipfs_version: ${{ matrix.ipfs }}\n          run_daemon: true\n      - name: Test IPFS ${{ steps.ipfs_setup.outputs.resolved_ipfs_version }} CLI and API\n        shell: bash\n        run: |\n          set -o pipefail\n          ipfs cat ${{ steps.ipfs_setup.outputs.welcome_ref }}/readme\n          curl -sX POST http://localhost:5001/api/v0/version | jq -e '(.Version==\"${{ steps.ipfs_setup.outputs.resolved_ipfs_version }}\")'\n```\n\n[See this example in action](https://github.com/ibnesayeed/setup-ipfs/blob/master/.github/workflows/test.yml).\n","funding_links":[],"categories":["Tools"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fibnesayeed%2Fsetup-ipfs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fibnesayeed%2Fsetup-ipfs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fibnesayeed%2Fsetup-ipfs/lists"}