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.

Sign up for GitHub

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

Jump to bottom

feat: Initial entry for a workflow to package the gui application. #1166

Merged
merged 15 commits into from
May 26, 2022
Merged

feat: Initial entry for a workflow to package the gui application. #1166

merged 15 commits into from
May 26, 2022

Conversation

bdferris-v2
Copy link
Collaborator

@bdferris-v2 bdferris-v2 commented May 25, 2022 •
edited

Implementation for a GitHub workflow to build the GUI application installers and packages on all key environments.

@bdferris-v2 bdferris-v2 marked this pull request as ready for review May 25, 2022 06:59
@bdferris-v2 bdferris-v2 linked an issue May 25, 2022 that may be closed by this pull request
Add the GUI app package to the test_pack_doc.yml workflow #1163
Closed
@bdferris-v2
Copy link
Collaborator Author

Per https://github.com/MobilityData/gtfs-validator/actions/runs/2382685953, this workflow is successfully packaging for Windows, Mac, and Linux. Ready for review.

@bdferris-v2 bdferris-v2 mentioned this pull request May 25, 2022
Closed
@maximearmstrong maximearmstrong changed the title Initial entry for a workflow to package the gui application. feat: Initial entry for a workflow to package the gui application. May 25, 2022
maximearmstrong
maximearmstrong reviewed May 25, 2022
View reviewed changes
Copy link
Contributor

@maximearmstrong maximearmstrong left a comment

Choose a reason for hiding this comment

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

Two small comments before approval. Thanks @bdferris-v2

.github/workflows/package_app.yml Outdated
- '**/package_app.yml'
release:
types: [ prereleased, released ]
workflow_dispatch:
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need the : here since we are not providing anything after?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think we do need it. I tried removing it and got a workflow error:

https://github.com/bdferris-v2/gtfs-validator/actions/runs/2387663309

More importantly, it seems pretty common to include the : in other projects:

https://sourcegraph.com/search?q=context:global+f:.github/workflows+workflow_dispatch&patternType=regexp

Copy link
Contributor

Choose a reason for hiding this comment

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

Perfect, thank you!

.github/workflows/package_app.yml Outdated Show resolved Hide resolved
@maximearmstrong
Copy link
Contributor

maximearmstrong commented May 25, 2022 •
edited

Also, now that #1168 is merged, the acceptance tests should pass for a future commit.

barbeau
barbeau reviewed May 26, 2022
View reviewed changes
Copy link
Member

@barbeau barbeau left a comment

Choose a reason for hiding this comment

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

Wow, I'm amazed that this was so straightforward 💯.

I tested the Windows installer that was uploaded and it works correctly 👍.

One small item in-line.

.github/workflows/package_app.yml Outdated
@@ -0,0 +1,50 @@
name: Package Application
Copy link
Member

Choose a reason for hiding this comment

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

Recommend renaming this (and file name) so it's more clearly distinguished from other workflows that also "package" the app. Maybe:

Suggested change
name: Package Application
name: Package Installer

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Seems reasonable. Done.

barbeau
barbeau approved these changes May 26, 2022
View reviewed changes
Copy link
Member

@barbeau barbeau left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @bdferris-v2!

maximearmstrong
maximearmstrong approved these changes May 26, 2022
View reviewed changes
Copy link
Contributor

@maximearmstrong maximearmstrong left a comment

Choose a reason for hiding this comment

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

One small thing aside, we are ready to merge :)

.github/workflows/package_installers.yml Outdated Show resolved Hide resolved
isabelle-dr
isabelle-dr requested changes May 26, 2022
View reviewed changes
Copy link
Contributor

@isabelle-dr isabelle-dr left a comment

Choose a reason for hiding this comment

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

I believe we could update README.md in this PR to add the instructions?
We could add a section "Run the validator app" describing (1) how to download the app and (2) how to use it.
If we want to mirror what we have with the JAR file, we will also need to include a DOWNLOAD_SNAPSHOT_APP.md similar to DOWNLOAD_SNAPSHOT_JAR.md.

@bdferris-v2
Copy link
Collaborator Author

@isabelle-dr I'm happy to write that documentation, but I think it's getting beyond the original scope of this PR? Would it be ok if I updated documentation in a follow-up PR?

@isabelle-dr
Copy link
Contributor

@bdferris-v2 No problem updating the documentation in another PR, I thought it was in scope.

@isabelle-dr
Copy link
Contributor

We just need to update this branch with master and we can merge.

@isabelle-dr isabelle-dr mentioned this pull request May 26, 2022
Closed
@bdferris-v2
Copy link
Collaborator Author

Done.

@maximearmstrong maximearmstrong merged commit 3ee0051 into MobilityData:master May 26, 2022
@maximearmstrong
Copy link
Contributor

Thank you @bdferris-v2 !

@bdferris-v2 bdferris-v2 mentioned this pull request May 27, 2022
Merged
@bdferris-v2 bdferris-v2 deleted the issue/1163/release branch May 31, 2022 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@barbeau barbeau barbeau approved these changes

@maximearmstrong maximearmstrong maximearmstrong approved these changes

@isabelle-dr isabelle-dr isabelle-dr approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add the GUI app package to the test_pack_doc.yml workflow
4 participants
@bdferris-v2 @maximearmstrong @isabelle-dr @barbeau