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

chore: add Github action to create release PR #164

Merged
merged 5 commits into from
Jul 12, 2024

Conversation

phantumcode
Copy link
Contributor

@phantumcode phantumcode commented Jul 2, 2024

Issue #, if available:

Description of changes:

How did you test these changes?
Adding Github action to automate the initial release PR with update versions for Liveness and Authenticator.
Depends on changes from this PR: aws-amplify/amplify-ci-support#179

Release action will update the following files:

  • Update the module/CHANGELOG.md
    • module changelog will ignore and exclude commits for other components based on the commit message scopes
  • Update the VERSION_NAME in module/gradle.properties
  • Update version used in sample app. NOTE: the amplify version in the sample apps is not updated and will need to manually verify/update for now as part of the release PR review.
  • Update module version in top-level README and module READMEs
  • Update the pull request template to ensure that commit message scopes are validated

Documentation update required?

  • No
  • Yes (Please include a PR link for the documentation update)

General Checklist

  • Added Unit Tests
  • Added Integration Tests
  • Security oriented best practices and standards are followed (e.g. using input sanitization, principle of least privilege, etc)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@phantumcode phantumcode requested review from a team as code owners July 2, 2024 15:39
@mattcreaser
Copy link
Member

UI components are released independently - it seems like this will release both at once with one version? Unless I'm missing something.

@phantumcode
Copy link
Contributor Author

Yes, it will release both components at the same time. I'll update it so the components are released independently.

@phantumcode
Copy link
Contributor Author

@mattcreaser I've updated the action so that each component can be released separately as a GH workflow dispatch input.

@tylerjroach
Copy link
Member

tylerjroach commented Jul 9, 2024

How is the changelog created. Ex: if we are releasing liveness is it going to inclue authenticator commits in changelog. This could be problematic when we then go to release authenticator and those changes are not included in changelog.

This effort is the reason we hadn't automated it yet. If this part has been resolved (including changes only for plugin between now and previous release + any core dependency updates during that time), this would be extremely helpful.

@phantumcode
Copy link
Contributor Author

@tylerjroach Good callout, I've updated the configuration and changelog generation so that it accounts for commit message scopes. The changelog generation for Liveness will exclude all commits that is scoped for Authenticator and vice-versa. All commits without a scope or isn't marked as ignored/exclude will be included by default.

@tylerjroach
Copy link
Member

@phantumcode You may have already covered this, but as an example. Lets say we update the material 3 library.

chore(all): Update Material3 library

Will both the next release of liveness and authenticator include this change? Or will only the first of these released include it? Sorry for asking so many questions, its difficult to fully understand what is being generated without seeing examples.

@phantumcode
Copy link
Contributor Author

@tylerjroach By default, both releases will include commits that are not part of the ignore/exclude list. So in your example, both releases will include the chore(all). We can potentially improve that by having an explicit rule to ensure that all commits with scope of all or core always get included as well if that makes things clearer.

@phantumcode
Copy link
Contributor Author

We could formalize this by requiring all commits to have scope of either liveness, authenticator, or all

tylerjroach
tylerjroach previously approved these changes Jul 10, 2024
@phantumcode phantumcode added this pull request to the merge queue Jul 12, 2024
Merged via the queue into main with commit 6e867b2 Jul 12, 2024
1 check passed
@phantumcode phantumcode deleted the phantum/automate_release_pr branch July 12, 2024 16:43
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.

3 participants