hyperledger / fabric-admin-sdk

Fabric SDK for Admin Capability services
Apache License 2.0
31 stars 19 forks source link

Add pipeline for auto release page creation. #78

Closed SamYuan1990 closed 1 year ago

SamYuan1990 commented 1 year ago

sample for preview https://github.com/SamYuan1990/fabric-admin-sdk/releases

git checkout origin main
git checkout main
git pull
git tag v0.0.0-alpha
git remote -v
git push origin v0.0.0-alpha
SamYuan1990 commented 1 year ago

fix #76

SamYuan1990 commented 1 year ago

I don't think this is a good idea. The README should provide information for people coming to the repository, not anything specific to a particular release version. The text for a GitHub release is more what you would expect to find in a chanegelog. It should provide a summary of that specific release.

An approach that seems to work well in other repositories is to have the creation of the GitHub release and its text (and associated Git tag) as a manual task, but then to have a GitHub Actions workflow triggered by the new tag drive any automated release pipeline.

@bestbeforetoday , so we will ref https://github.com/hyperledger/fabric to have tag to document link and release pages? or https://github.com/hyperledger/fabric-sdk-go#retired-versions

bestbeforetoday commented 1 year ago

I would suggest creating a GitHub release using the GitHub Web UI when you want to publish a release version. Here you can add the release notes for the release, and it will also create a Git tag for you. Any automated processes you want to run as part of that release can be triggered by the tag in a GitHub Actions workflow, like how Fabric does here (although you might want to use v** as the tag name to trigger from any tag starting with a v).

SamYuan1990 commented 1 year ago

ok, let's close this one and use github web ui