{"id":15687353,"url":"https://github.com/irongut/editrelease","last_synced_at":"2025-04-15T01:43:36.741Z","repository":{"id":37030549,"uuid":"408241272","full_name":"irongut/EditRelease","owner":"irongut","description":"A GitHub Action for editing an existing release.","archived":false,"fork":false,"pushed_at":"2025-04-01T02:15:03.000Z","size":135,"stargazers_count":9,"open_issues_count":2,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-14T11:02:32.934Z","etag":null,"topics":["action","github-actions","github-releases","release","release-notes"],"latest_commit_sha":null,"homepage":"","language":"C#","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/irongut.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["irongut"]}},"created_at":"2021-09-19T21:31:15.000Z","updated_at":"2024-07-13T11:06:46.000Z","dependencies_parsed_at":"2024-04-29T12:53:03.553Z","dependency_job_id":null,"html_url":"https://github.com/irongut/EditRelease","commit_stats":{"total_commits":108,"total_committers":2,"mean_commits":54.0,"dds":0.4907407407407407,"last_synced_commit":"4aaab3a036b10f255c69141b1494ff45a326409e"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/irongut%2FEditRelease","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/irongut%2FEditRelease/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/irongut%2FEditRelease/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/irongut%2FEditRelease/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/irongut","download_url":"https://codeload.github.com/irongut/EditRelease/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248991525,"owners_count":21194893,"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":["action","github-actions","github-releases","release","release-notes"],"created_at":"2024-10-03T17:47:47.518Z","updated_at":"2025-04-15T01:43:36.724Z","avatar_url":"https://github.com/irongut.png","language":"C#","readme":"# Edit Release\n\n\u003cdiv align=\"center\"\u003e\n\n![.NET 6.0](https://img.shields.io/badge/Version-.NET%206.0-informational?style=flat\u0026logo=dotnet)\n\u0026nbsp;\n![Built With Docker](https://img.shields.io/badge/Built_With-Docker-informational?style=flat\u0026logo=docker)\n\u0026nbsp;\n[![CI Build](https://github.com/irongut/EditRelease/actions/workflows/ci-build.yml/badge.svg)](https://github.com/irongut/EditRelease/actions/workflows/ci-build.yml)\n\u0026nbsp;\n[![CodeQL Scan](https://github.com/irongut/EditRelease/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/irongut/EditRelease/actions/workflows/codeql-analysis.yml)\n\n\u003c/div\u003e\n\nA GitHub Action for editing an existing release. Edit the Name, Draft status and Pre-release status of a release as well as adding text and the content of markdown files to the Body of a release.\n\nEdit Release is compatible with [StepSecurity Secure Workflows](https://github.com/step-security/secure-workflows) and uses a Docker image that is cryptographically signed using [Sigstore](https://www.sigstore.dev/).\n\nAs a Docker based action Edit Release requires a Linux runner, see [Types of Action](https://docs.github.com/en/actions/creating-actions/about-custom-actions#types-of-actions).\n\n## Inputs\n\n#### `token`\n**Required**\n\nAuthentication token, use either `GITHUB_TOKEN` or a Personal Access Token.\n\n#### `id`\n**Required**\n\nThe id of the release to edit, e.g. `github.event.release.id`.\n\n#### `name`\n\nNew text for the name of the release.\n\n#### `replacename`\n\nSet `true` to replace the release name, `false` to add to the release name (default).\n\n#### `draft`\n\nSet `true` to change the release to a draft, `false` to publish the release. Omit if you do not want to change the draft status of the release.\n\n#### `prerelease`\n\nSet `true` to identify the release as a pre-release, `false` to identify the release as a full release. Omit if you do not want to change the status of the release.\n\n#### `body`\n\nNew text for the body of the release.\n\n#### `replacebody`\n\nSet `true` to replace the release body, `false` to add to the release body. (default)\n\n#### `files`\n\nA comma separated list of files whose content will be added after the release body text.\n\n#### `spacing`\n\nThe number of blank lines required between each addition to the release body. (default = 1)\n\n## Outputs\n\nEdit Release has no outputs other than console messages and the edited release.\n\n## Usage\n\n```yaml\nname: Edit Release\nuses: irongut/EditRelease@v1.2.0\nwith:\n  token: ${{ secrets.GITHUB_TOKEN }}\n  id: ${{ github.event.release.id }}\n  name: \"Beta\"\n  prerelease: true\n  body: \"This is a pre-release version for testing purposes.\"\n  files: \"changelog.md,testcoverage.md\"\n```\n\n### Workflow Example\n\nThis workflow will run when you publish a release. It builds and tests a .Net 5 Nuget library before deploying it to GitHub Packages and adding a test coverage report to the release.\n\n```yaml\nname: Build + Deploy\n\non:\n  release:\n    types: [published]\n    branches: [master]\n\nenv:\n  GITHUB_PACKAGE_URL: 'https://nuget.pkg.github.com/${{ github.repository_owner }}/index.json'\n\njobs:\n  build:\n    runs-on: ubuntu-latest\n    name: Release Build\n    steps:\n    - name: Checkout\n      uses: actions/checkout@v2\n      with:\n        fetch-depth: 0\n\n    - name: Setup .NET\n      uses: actions/setup-dotnet@v1\n      with:\n        dotnet-version: 5.0.x\n\n    - name: Restore Dependencies\n      run: dotnet restore src/Example.sln\n\n    - name: Build\n      run: dotnet build src/Example.sln --configuration Release --no-restore\n\n    - name: Test\n      run: dotnet test src/Example.sln --configuration Release --no-build --verbosity normal --collect:\"XPlat Code Coverage\" --results-directory ./coverage\n\n    - name: Copy Test Details\n      run: cp coverage/**/coverage.cobertura.xml coverage/coverage.cobertura.xml\n\n    - name: Create Test Report\n      uses: irongut/CodeCoverageSummary@v1.2.0\n      with:\n        filename: coverage/coverage.cobertura.xml\n        badge: true\n        format: 'markdown'\n        output: 'both'\n\n    - name: Upload Nuget Artifact\n      uses: actions/upload-artifact@v2.2.4\n      with:\n        name: release-nuget\n        path: src/Example/bin/Release/Example.Library*.nupkg\n\n    - name: Upload Test Report Artifact\n      uses: actions/upload-artifact@v2.2.4\n      with:\n        name: release-nuget\n        path: code-coverage-results.md\n\n  deploy:\n    name: Deploy to GitHub Packages\n    needs: [build]\n    runs-on: ubuntu-latest\n    steps:\n    - name: Download Artifacts\n      uses: actions/download-artifact@v2\n      with:\n        name: release-nuget\n\n    - name: Setup Nuget\n      uses: NuGet/setup-nuget@v1.0.5\n      with:\n        nuget-version: latest\n\n    - name: Add GitHub package source\n      run: nuget sources Add -Name GitHub -Source ${{env.GITHUB_PACKAGE_URL}} -UserName ${{ github.repository_owner }} -Password ${{ secrets.GITHUB_TOKEN }}\n\n    - name: Push to GitHub Packages\n      run: nuget push **/*.nupkg -source GitHub -SkipDuplicate\n\n    - name: Add Test Report to Release\n      uses: irongut/EditRelease@v1.2.0\n      with:\n        token: ${{ secrets.GITHUB_TOKEN }}\n        id: ${{ github.event.release.id }}\n        body: \"Released to GitHub Packages.\"\n        files: \"code-coverage-results.md\"\n```\n\n## Contributing\n\n### Report Bugs\n\nPlease make sure the bug is not already reported by searching existing [issues].\n\nIf you're unable to find an existing issue addressing the problem please [open a new one][new-issue]. Be sure to include a title and clear description, as much relevant information as possible, a workflow sample and any logs demonstrating the problem.\n\n### Suggest an Enhancement\n\nPlease [open a new issue][new-issue].\n\n### Submit a Pull Request\n\nDiscuss your idea first, so that your changes have a good chance of being merged in.\n\nSubmit your pull request against the `master` branch.\n\nPull requests that include documentation and relevant updates to README.md will be merged faster.\n\n## License\n\nEdit Release Action is available under the MIT license, see the [LICENSE](LICENSE) file for more info.\n\n[issues]: https://github.com/irongut/EditRelease/issues\n[new-issue]: https://github.com/irongut/EditRelease/issues/new\n","funding_links":["https://github.com/sponsors/irongut"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Firongut%2Feditrelease","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Firongut%2Feditrelease","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Firongut%2Feditrelease/lists"}