Skip to content

Commit

Permalink
Merge pull request #530 from IntersectMBO/smelc/add-github-release-in…
Browse files Browse the repository at this point in the history
…structions

Update RELEASING.md to account for GitHub release creation by the CLI pipeline
  • Loading branch information
smelc committed May 7, 2024
2 parents f936cd9 + c4b9f01 commit 1b0738d
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,15 @@ Briefly speaking, it requires executing of the following steps:
>
>CHaP CI build can fail due to various reasons, like invalid haddock syntax.
>Merging the release PR later allows easier adjusting of the tag to include the fix for the potential issues.
1. If a GitHub release is automatically created by the CI, as visible on https://github.com/IntersectMBO/cardano-api/releases,
undraft the release by clicking the pen on the top right, then untick _Set as a pre-release_, and
finally select _Update release_.

>:warning: **GitHub bug**
>
> If you try to undraft a PR using the [gh API](https://docs.github.com/fr/rest/releases/releases?apiVersion=2022-11-28#update-a-release),
> you will observe that the `PATCH` endpoint messes up existing metadata of the release (author, associated commit, etc.).
> So you HAVE to use the UI, as described above.
## Troubleshooting

Expand Down

0 comments on commit 1b0738d

Please sign in to comment.