search

OpenAstronomy / github-actions-workflows

Reusable workflows for GitHub Actions
https://github-actions-workflows.openastronomy.org
MIT License
19 stars 13 forks source link

Tag initial version #19

Closed astrofrog closed 2 years ago

astrofrog commented 2 years ago

I'd like to start using the publishing workflows in production but before doing that I think it would be good to tag a first version so we can @v1 to avoid any breakages.

Will we just go with semantic versioning and start at 1.0.0? Does @v1 include all 1.x.x releases?

ConorMacBride commented 2 years ago

Will we just go with semantic versioning and start at 1.0.0?

I think so :+1:

Does @v1 include all 1.x.x releases?

Maybe not because actions/upload-artifact for example move the v_ tag to point to the latest v_._._.

Edit: accidentally pinged username v1 😆 Sorry!

astrofrog commented 2 years ago

I wonder if there is an existing GitHub action that will do that automatically?

astrofrog commented 2 years ago

Ah like this: https://github.com/marketplace/actions/update-major-version

ConorMacBride commented 2 years ago

Maybe we should resolve https://github.com/OpenAstronomy/github-actions-workflows/issues/9#issuecomment-1065669316 before using tags?

astrofrog commented 2 years ago

Yes good point

ConorMacBride commented 2 years ago

I tried out https://github.com/marketplace/actions/update-major-version in ConorMacBride/install-package and it worked well. Just pushed the update_tag.yml, and then pushed a v1.0.0 tag and it created the v1 tag at the same sha.

Cadair commented 2 years ago

fancy

astrofrog commented 2 years ago

Great!

astrofrog commented 2 years ago

Should we try and resolve https://github.com/OpenAstronomy/github-actions-workflows/issues/21 as the last point before we tag, since it would be a change of API effectively?

astrofrog commented 2 years ago

@ConorMacBride @Cadair - now that #21 is resolved, shall we go ahead and tag a first release here?

ConorMacBride commented 2 years ago

Yes :+1:

astrofrog commented 2 years ago

@ConorMacBride - would you like to go ahead and do that? I guess we need to add the action for the auto-tagging first?

ConorMacBride commented 2 years ago

Okay, I'll add the workflow just like here: https://github.com/ConorMacBride/install-package/blob/main/.github/workflows/update_tag.yml

And then I'll push a v1.0.0 tag.

ConorMacBride commented 2 years ago

Done! 🎉 (Should probably disable PyPI upload in the tests so pushing a tag doesn't fail the tests: https://github.com/OpenAstronomy/github-actions-workflows/runs/5558235131?check_suite_focus=true)

Cadair commented 2 years ago

Thanks! Close?