Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[INFRA] Automate tag and files update #47

Closed
6 tasks done
tbouffard opened this issue Sep 2, 2021 · 0 comments · Fixed by #145
Closed
6 tasks done

[INFRA] Automate tag and files update #47

tbouffard opened this issue Sep 2, 2021 · 0 comments · Fixed by #145
Assignees
Labels
chore Build, CI/CD or repository tasks (issues/PR maintenance, environments, ...)
Milestone

Comments

@tbouffard
Copy link
Member

tbouffard commented Sep 2, 2021

Currently (in v0.2.1), the version must be updated prior and after releasing (by creating a PR). This is painful and error prone
The git tag is created only when the GitHub release is published.

I suggest we do something like for the bpmn-visualization TypeScript library.
We provide a GitHub workflow that will do everything for us:

  • It takes as an input the version to release.
  • it updates the files with the new version and commit
  • then it creates the related tag
  • then it updates the files with the development version and commit
  • finally, it push the changes and the tag

If possible, the development version should be automatically computed by the workflow to avoid human error

Tasks to do

Add a Github workflow triggered by workflow_dispatch (manual run)

  • pass the new version
  • update the files containing the version accordingly (see MAINTAINERS.md)
  • create the git tag
  • set the development version accordingly (see MAINTAINERS.md)
  • push all commits and the tag

Documentation

  • update MAINTAINERS.md to explain the new release process

Notes

  • remember that the GH_TOKEN has readonly permissions by default
  • check how we proceed in the bpmn-visualization-js repo
  • don't forget to use the playground repository for testing
@tbouffard tbouffard changed the title [INFRA] Automate tag and DESCRIPTION update [INFRA] Automate tag and files update Mar 30, 2022
@tbouffard tbouffard added chore Build, CI/CD or repository tasks (issues/PR maintenance, environments, ...) and removed infra:repo labels Aug 30, 2022
@tbouffard tbouffard added this to the 0.2.2 milestone Nov 17, 2022
@csouchet csouchet modified the milestones: 0.2.2, 0.3.0 Nov 17, 2022
@tbouffard tbouffard modified the milestones: 0.3.0, 0.2.2 Nov 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Build, CI/CD or repository tasks (issues/PR maintenance, environments, ...)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants