8000 feat(ParrotDevtools): add GH action functionality by amexjake · Pull Request #132 · americanexpress/parrot · GitHub
[go: up one dir, main page]

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

feat(ParrotDevtools): add GH action functionality #132

Merged

Conversation

amexjake
Copy link
Contributor

This PR addresses issue #94 by adding a new GitHub action and accompanying script to automate the parrot-devtools extension deployment when PRs making changes to those files get merged.

Description

This PR has two main components: the workflow action, and the deployment script.

The action will fire when a PR is closed against the main branch and if the PR contains changes to the parrot-devtools extension files. If it is, it will check to see if the PR was merged, it will attempt to invoke the deployment script. If the PR was closed without merging, a short message will be logged in the action console and nothing else.

The deployment script takes advantage of an npm package to upload a zip file to the Chrome Webstore and then publish the extension. It relies on 4 environment variables which will be exposed by the Action using GitHubs encrypted secret manager for the Parrot repo.

Motivation and Context

This automation will remove a tedious manual task from the Parrot maintainers' workloads and simultaneously remove the dependency of a maintainer in order to ensure changes to the parrot-devtools extension are published.

How Has This Been Tested?

These changes have been tested extensively in my own repo using a slightly modified action to ensure that the script and tokens all worked as expected.

Types of Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation (adding or updating documentation)
  • Dependency update

Checklist:

  • My change requires a change to the documentation and I have updated the documentation accordingly.
  • My changes are in sync with the code style of this project.
  • There aren't any other open Pull Requests for the same issue/update.
  • These changes should be applied to a maintenance branch.
  • This change requires cross browser checks.
  • This change impacts caching for client browsers.
  • I have added the Apache 2.0 license header to any new files created.

What is the Impact to Developers Using parrot?

The two main things that Parrot devs should know is that
a) this automates a publishing process, and as such, EVERYTHING that gets merged to the main branch should be production ready.
b) the action will require configuring the 4 environment variables as repo secrets. @amexjake (me) can do this since I'm a maintainer, but it should be noted that the scripts won't work without these secrets defined.

@amexjake amexjake requested a review from a team as a code owner July 16, 2021 20:51
@amexjake amexjake requested review from AdamFoskit and a user July 16, 2021 20:56
@marcusrbrown marcusrbrown enabled auto-merge (squash) July 17, 2021 05:52
@github-actions
Copy link

This pull request is stale because it has been open 30 days with no activity.

@marcusrbrown
Copy link
Contributor

Oof. My bad, I will get on these.

@github-actions github-actions bot removed the stale-pr label Aug 18, 2021
@github-actions
Copy link

This pull request is stale because it has been open 30 days with no activity.

@marcusrbrown marcusrbrown merged commit 8ca4962 into americanexpress:main Feb 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0