Skip to content

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

Merged
maximearmstrong merged 15 commits intoMobilityData:masterfrom
bdferris-v2:issue/1163/release
May 26, 2022
Merged

feat: Initial entry for a workflow to package the gui application.#1166
maximearmstrong merged 15 commits intoMobilityData:masterfrom
bdferris-v2:issue/1163/release

Conversation

@bdferris-v2
Copy link
Copy Markdown
Collaborator

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

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
@bdferris-v2
Copy link
Copy Markdown
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.

@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
Copy link
Copy Markdown
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

- '**/package_app.yml'
release:
types: [ prereleased, released ]
workflow_dispatch:
Copy link
Copy Markdown
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
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Perfect, thank you!

@maximearmstrong
Copy link
Copy Markdown
Contributor

maximearmstrong commented May 25, 2022

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

Copy link
Copy Markdown
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.

@@ -0,0 +1,50 @@
name: Package Application
Copy link
Copy Markdown
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
Copy Markdown
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.

Copy link
Copy Markdown
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!

Copy link
Copy Markdown
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 :)

Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
Contributor

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

@isabelle-dr
Copy link
Copy Markdown
Contributor

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

@bdferris-v2
Copy link
Copy Markdown
Collaborator Author

Done.

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

Thank you @bdferris-v2 !

@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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add the GUI app package to the test_pack_doc.yml workflow

4 participants