Skip to content

Add versioning and changelogs to QD apps #273

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

Merged
merged 3 commits into from
Aug 20, 2021

Conversation

jmulcahey-twilio
Copy link
Contributor

Description

Sets the versions of all Quick Deploy apps to 1.0.0, and adds a CHANGELOG.md based around the keep a changelog format to meta-template. This is the groundwork to enable @dkundel's ideas around an update mechanism for deployed Quick Deploy apps.

Some things to consider:

  • Currently, changelogs are handled manually. I couldn't find any tooling that would non-clumsily support multiple changelogs in a single Git repo. If anyone's aware of a good option here, please let me know.
  • Only meta-template has a changelog so far. I plan to copy its skeleton changelog to each app in the repo, if the keep a changelog format is considered acceptable.

Checklist

  • I ran npm test locally and it passed without errors.
  • I acknowledge that all my contributions will be made under the project's license.

Related issues

@jmulcahey-twilio jmulcahey-twilio changed the title App versioning 1 Add versioning and changelogs to QD apps Aug 18, 2021
Copy link
Contributor

@philnash philnash left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This all seems fine to me. Seems like the difficult parts will be in the quick deploy update mechanism.

For consistency, should we also add versions to any templates that aren't in quick deploy too?

@jmulcahey-twilio
Copy link
Contributor Author

This all seems fine to me. Seems like the difficult parts will be in the quick deploy update mechanism.

For consistency, should we also add versions to any templates that aren't in quick deploy too?

Agreed! The Maestro portions of this will definitely need some thought put into how we design them.

I added versioning to every app in function-templates so our non-QD stuff in this repo should be covered. If there's anything I missed though, let me know and I'll add it!

@jmulcahey-twilio jmulcahey-twilio merged commit 7b614ab into twilio-labs:main Aug 20, 2021
@jmulcahey-twilio jmulcahey-twilio deleted the app-versioning-1 branch August 20, 2021 22:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants