{"id":20187525,"url":"https://github.com/bitrise-steplib/steps-github-release","last_synced_at":"2025-04-10T06:43:28.040Z","repository":{"id":33372186,"uuid":"136489578","full_name":"bitrise-steplib/steps-github-release","owner":"bitrise-steplib","description":null,"archived":false,"fork":false,"pushed_at":"2024-07-11T07:25:48.000Z","size":785,"stargazers_count":3,"open_issues_count":0,"forks_count":9,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-03-24T07:50:52.523Z","etag":null,"topics":["bitrise","bitrise-step","ci","hacktoberfest","production-code"],"latest_commit_sha":null,"homepage":"","language":"Go","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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-06-07T14:31:38.000Z","updated_at":"2024-07-11T07:25:51.000Z","dependencies_parsed_at":"2024-11-14T03:26:21.369Z","dependency_job_id":"61678843-461b-4e22-9c5b-eb500056ebee","html_url":"https://github.com/bitrise-steplib/steps-github-release","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitrise-steplib%2Fsteps-github-release","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitrise-steplib%2Fsteps-github-release/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitrise-steplib%2Fsteps-github-release/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitrise-steplib%2Fsteps-github-release/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bitrise-steplib","download_url":"https://codeload.github.com/bitrise-steplib/steps-github-release/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248173463,"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","hacktoberfest","production-code"],"created_at":"2024-11-14T03:24:28.801Z","updated_at":"2025-04-10T06:43:28.013Z","avatar_url":"https://github.com/bitrise-steplib.png","language":"Go","readme":"# Github Release\n\nCreate Github Release\n\n## How to use this Step\n\nCan be run directly with the [bitrise CLI](https://github.com/bitrise-io/bitrise),\njust `git clone` this repository, `cd` into it's folder in your Terminal/Command Line\nand call `bitrise run test`.\n\n_Check the `bitrise.yml` file for required inputs which have to be\nadded to your `.bitrise.secrets.yml` file!_\n\nStep by step:\n\n1.  Open up your Terminal / Command Line\n2.  `git clone` the repository\n3.  `cd` into the directory of the step (the one you just `git clone`d)\n4.  Create a `.bitrise.secrets.yml` file in the same directory of `bitrise.yml`\n    (the `.bitrise.secrets.yml` is a git ignored file, you can store your secrets in it)\n5.  Check the `bitrise.yml` file for any secret you should set in `.bitrise.secrets.yml`\n\n* Best practice is to mark these options with something like `# define these in your .bitrise.secrets.yml`, in the `app:envs` section.\n\n7.  Once you have all the required secret parameters in your `.bitrise.secrets.yml` you can just run this step with the [bitrise CLI](https://github.com/bitrise-io/bitrise): `bitrise run test`\n\nAn example `.bitrise.secrets.yml` file:\n\n```\nenvs:\n- A_SECRET_PARAM_ONE: the value for secret one\n- A_SECRET_PARAM_TWO: the value for secret two\n```\n\n## How to create your own step\n\n1.  Create a new git repository for your step (**don't fork** the _step template_, create a _new_ repository)\n2.  Copy the [step template](https://github.com/bitrise-steplib/step-template) files into your repository\n3.  Fill the `step.sh` with your functionality\n4.  Wire out your inputs to `step.yml` (`inputs` section)\n5.  Fill out the other parts of the `step.yml` too\n6.  Provide test values for the inputs in the `bitrise.yml`\n7.  Run your step with `bitrise run test` - if it works, you're ready\n\n**For Step development guidelines \u0026 best practices** check this documentation: [https://github.com/bitrise-io/bitrise/blob/master/\\_docs/step-development-guideline.md](https://github.com/bitrise-io/bitrise/blob/master/_docs/step-development-guideline.md).\n\n**NOTE:**\n\nIf you want to use your step in your project's `bitrise.yml`:\n\n1.  git push the step into it's repository\n2.  reference it in your `bitrise.yml` with the `git::PUBLIC-GIT-CLONE-URL@BRANCH` step reference style:\n\n```\n- git::https://github.com/user/my-step.git@branch:\n   title: My step\n   inputs:\n   - my_input_1: \"my value 1\"\n   - my_input_2: \"my value 2\"\n```\n\nYou can find more examples of step reference styles\nin the [bitrise CLI repository](https://github.com/bitrise-io/bitrise/blob/master/_examples/tutorials/steps-and-workflows/bitrise.yml#L65).\n\n## How to contribute to this Step\n\n1.  Fork this repository\n2.  `git clone` it\n3.  Create a branch you'll work on\n4.  To use/test the step just follow the **How to use this Step** section\n5.  Do the changes you want to\n6.  Run/test the step before sending your contribution\n\n* You can also test the step in your `bitrise` project, either on your Mac or on [bitrise.io](https://www.bitrise.io)\n* You just have to replace the step ID in your project's `bitrise.yml` with either a relative path, or with a git URL format\n* (relative) path format: instead of `- original-step-id:` use `- path::./relative/path/of/script/on/your/Mac:`\n* direct git URL format: instead of `- original-step-id:` use `- git::https://github.com/user/step.git@branch:`\n* You can find more example of alternative step referencing at: https://github.com/bitrise-io/bitrise/blob/master/_examples/tutorials/steps-and-workflows/bitrise.yml\n\n7.  Once you're done just commit your changes \u0026 create a Pull Request\n\n## Share your own Step\n\nYou can share your Step or step version with the [bitrise CLI](https://github.com/bitrise-io/bitrise). If you use the `bitrise.yml` included in this repository, all you have to do is:\n\n1.  In your Terminal / Command Line `cd` into this directory (where the `bitrise.yml` of the step is located)\n1.  Run: `bitrise run test` to test the step\n1.  Run: `bitrise run audit-this-step` to audit the `step.yml`\n1.  Check the `share-this-step` workflow in the `bitrise.yml`, and fill out the\n    `envs` if you haven't done so already (don't forget to bump the version number if this is an update\n    of your step!)\n1.  Then run: `bitrise run share-this-step` to share the step (version) you specified in the `envs`\n1.  Send the Pull Request, as described in the logs of `bitrise run share-this-step`\n\nThat's all ;)\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","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitrise-steplib%2Fsteps-github-release","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbitrise-steplib%2Fsteps-github-release","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitrise-steplib%2Fsteps-github-release/lists"}