{"id":20187862,"url":"https://github.com/bitrise-steplib/steps-testfairy-deploy","last_synced_at":"2025-04-10T06:44:40.955Z","repository":{"id":27822153,"uuid":"31311810","full_name":"bitrise-steplib/steps-testfairy-deploy","owner":"bitrise-steplib","description":null,"archived":false,"fork":false,"pushed_at":"2024-03-21T12:17:37.000Z","size":32,"stargazers_count":2,"open_issues_count":1,"forks_count":6,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-03-24T07:52:43.278Z","etag":null,"topics":["bitrise","bitrise-step","ci","production-code"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/bitrise-steplib.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}},"created_at":"2015-02-25T12:06:15.000Z","updated_at":"2021-10-05T11:19:05.000Z","dependencies_parsed_at":"2022-08-24T23:00:59.209Z","dependency_job_id":null,"html_url":"https://github.com/bitrise-steplib/steps-testfairy-deploy","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitrise-steplib%2Fsteps-testfairy-deploy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitrise-steplib%2Fsteps-testfairy-deploy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitrise-steplib%2Fsteps-testfairy-deploy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitrise-steplib%2Fsteps-testfairy-deploy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bitrise-steplib","download_url":"https://codeload.github.com/bitrise-steplib/steps-testfairy-deploy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248173826,"owners_count":21059595,"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":["bitrise","bitrise-step","ci","production-code"],"created_at":"2024-11-14T03:26:13.644Z","updated_at":"2025-04-10T06:44:40.930Z","avatar_url":"https://github.com/bitrise-steplib.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# StepTestFairyDeploy\n\n\n\n## Test run this Step on your own machine\n\nSteps get their inputs through Environment Variables.\nThe Step's inputs are described in the `step.yml` Step\ndescription file.\n\nTo run a Step locally you have to define it's\ninputs (environment variables) before you could run\nthe Step.\n\nA simple way to do this in your Command Line / Terminal\nis to call it like this:\n\n\tcd path/to/step/directory\n\n    (\n    \texport INPUT_VAR_1=\"My value 1\"\n    \texport INPUT_VAR_2=\"My value 2\"\n    \t...\n    \tbash step.sh\n    )\n\n*Including the environment variable definitions\nin a `(...)` block helps to keep your\nCommand Line / Terminal environment clean, those\ninput environments are only available\ninside the `(...)` block.*\n\nIf you plan to test it multiple times you can\nsave this as a shell script\nand simply call it as many times as you want to.\n\n\n## Create your own Step:\n\n1. Create a new repository on GitHub\n2. Copy the files from the [step-template repository](https://github.com/steplib/step-template)\n3. Commit and push it\n\nHurray, you just created your first Step repository!\nYou can now start coding and when you're ready\nyou can submit your Step to the [Open Step Library](http://www.steplib.com/).\n\n\n## Step Repository Structure\n\n### step.sh\n\nThis is the **entry point of the Step**. A StepLib\nsystem will execute this file when it runs the Step.\nYou can run other scripts and programs from\n*step.sh*. For example if you want to write your\nStep in ruby then all you have to include in the *step.sh*\nfile is the code to run your own ruby script,\nsomething like this:\n\n    #!/bin/bash\n  \n    THIS_SCRIPT_DIR=\"$( cd \"$( dirname \"${BASH_SOURCE[0]}\" )\" \u0026\u0026 pwd )\"\n  \n    ruby \"${THIS_SCRIPT_DIR}/my_ruby_script.rb\"\n    exit $?\n\n\n**inputs**: a Step should get it's inputs through\n*environment variables*. These inputs can be (and should be)\nspecified in the *step.yml* description of the Step.\n\n**exit code**: the exit code generated by step.sh\nis interpreted as the success/failure code of the whole Step.\nIf it returns 0 the Step will be considered as successful.\nIf it returns with a greater than 0 exit code then\nthe Step is considered to be failed.\n\n\n### step.yml\n\nDescription of the step in YAML format.\n\nSpecifies information for StepLib users like what platforms\nthe Step supports, what's the official website of the\nStep, where can a user find the Step's code and\nwhere can a user fork the Step.\n\nAlso defines an input list for the Step which then\ncan be presented as User Interface for the Step\nand a StepLib compatible system can interpret these\ninputs and map the user input values to\nenvironment variables which will be available for the Step.\n\nFor a full description of the *step.yml* description\nfile see the documentation on GitHub: [https://github.com/steplib/steplib/blob/master/docs/step_format.md](https://github.com/steplib/steplib/blob/master/docs/step_format.md)\n\n\n### LICENSE\n\nWe don't accept steps into the StepLib without a license included in it!\nRead more about why it's important to have a license file\nin your open source repository on GitHub: [https://github.com/steplib/steplib/blob/master/templates/step/LICENSE](https://github.com/steplib/steplib/blob/master/templates/step/LICENSE).\n\n\n### README.md\n\nTechnically README is not required but we strongly suggest\nagainst not using one.\n\nIt can be a very simple description of what your Step does,\nin just a couple of sentences.\n\nBest practice is to include information about how\nsomeone else can contribute to the development of the Step.\n\nYou can also include a link to the StepLib website, including your\nown Step's page on StepLib (once it's submitted\ninto the Open StepLib collection), something like this:\n\nThis Step is part of the [Open StepLib](http://www.steplib.com/),\nyou can find its page on StepLib [here](http://www.steplib.com/step/your-step-id).\n\n\n## How to submit your Step into the Open Step Library\n\nTo submit a Step to the [Open Step Library](http://www.steplib.com/)\nyou have to create a Pull Request in the StepLib's spec repository\nand include your step's `step.yml` description file\nin the **steps/** folder.\n\n1. Create your Step repository as described above.\n2. Fork the StepLib spec repository: [https://github.com/steplib/steplib](https://github.com/steplib/steplib)\n3. Create a new folder inside the **steps/** folder (in your forked StepLib spec repository) if it's the first version of your Step. (Example path: `steps/my-step`). *Note: The name of the folder will be the ID of your Step.*\n4. Create a folder inside your step's folder with the name of a version tag you added to your Step repository. (Example path: `steps/my-step/1.0.0`). **You have to actually use this tag in your repository**. When a user wants to use this version of your Step the StepLib system will try to clone your Step repository with the specified version tag!\n5. Copy your step.yml into this version folder (Example path: `steps/my-step/1.0.0/step.yml`)\n6. Create and send a Pull Request\n\n*Before you submit your Step into a Step Library you should test it in a StepLib compatible system.\nYou can use a free [Bitrise](http://www.bitrise.io/) account to test your Step.*\n\n## Trigger a new release\n\n- __merge every code changes__ to the `master` branch\n- __push the new version tag__ to the `master` branch\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitrise-steplib%2Fsteps-testfairy-deploy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbitrise-steplib%2Fsteps-testfairy-deploy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitrise-steplib%2Fsteps-testfairy-deploy/lists"}