finos
GHA: Only run GHA comment script if PR origin is from FINOS
Describe your change
Previously, when externally-originating PRs are opened, they receive this error:
Run thollander/actions-comment-pull-request@v3
Error: Resource not accessible by integration
This is because externally-originating PRs don't have permission to run that particular script. So, all externally-originating PRs would always fail due to permissions issues.
This PR checks the origin of PR, and does not call the step if it's external.
Related Issue
Resolves https://github.com/finos/FDC3/issues/1519
Contributor License Agreement
- [ ] I acknowledge that a contributor license agreement is required and that I have one in place or will seek to put one in place ASAP.
Review Checklist
- [x] Issue: If a change was made to the FDC3 Standard, was an issue linked above?
- [ ] CHANGELOG: Is a CHANGELOG.md entry included?
- [ ] API changes: Does this PR include changes to any of the FDC3 APIs (
DesktopAgent,Channel,PrivateChannel,Listener,Bridging)?- [ ] Docs & Sources: If yes, were both documentation (/docs) and sources updated?
JSDoc comments on interfaces and types should be matched to the main documentation in /docs - [ ] Conformance tests: If yes, are conformance test definitions (/toolbox/fdc3-conformance) still correct and complete?
Conformance test definitions should cover all required aspects of an FDC3 Desktop Agent implementation, which are usually marked with a MUST keyword, and optional features (SHOULD or MAY) where the format of those features is defined - [ ] Schemas: If yes, were changes applied to the Bridging and FDC3 for Web protocol schemas?
The Web Connection protocol and Desktop Agent Communication Protocol schemas must be able to support all necessary aspects of the Desktop Agent API, while Bridging must support those aspects necessary for Desktop Agents to communicate with each other- [ ] If yes, was code generation (
npm run build) run and the results checked in?
Generated code will be found at/src/api/BrowserTypes.tsand/or/src/bridging/BridgingTypes.ts
- [ ] If yes, was code generation (
- [ ] Docs & Sources: If yes, were both documentation (/docs) and sources updated?
- [ ] Context types: Were new Context type schemas created or modified in this PR?
- [ ] Were the field type conventions adhered to?
- [ ] Was the
BaseContextschema applied viaallOf(as it is in existing types)? - [ ] Was a
titleanddescriptionprovided for all properties defined in the schema? - [ ] Was at least one example provided?
- [ ] Was code generation (
npm run build) run and the results checked in?
Generated code will be found at/src/context/ContextTypes.ts
- [ ] Intents: Were new Intents created in this PR?
- [ ] Were the intent name prefixes and other naming conventions & characteristics adhered to?
- [ ] Was the new intent added to the list in the Intents Overview?
Deploy Preview for fdc3 canceled.
| Name | Link |
|---|---|
| Latest commit | 6684c1f1ed5ce06996b0c56a72d5a91f575e9785 |
| Latest deploy log | https://app.netlify.com/projects/fdc3/deploys/6852a110ba1ba500088958e0 |
![netlify[bot] avatar](https://avatars.githubusercontent.com/in/13473?v=4 "Published by a pub.dev verified publisher"){kind=small}
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
Coverage Report
Commit: 6684c1f Base: main@7085ed3
| Type | Base | This PR |
|---|---|---|
| Total Statements Coverage |  97.66% |
97.66% (+0%) |
| Total Branches Coverage | 87.07% |
87.07% (+0%) |
| Total Functions Coverage | 96.65% |
96.65% (+0%) |
| Total Lines Coverage | 97.74% |
97.74% (+0%) |
Details (changed files)
| File | Statements | Branches | Functions | Lines |
|---|
Details (all files)
| File | Statements | Branches | Functions | Lines |
|---|---|---|---|---|
| packages/fdc3-agent-proxy/src/DesktopAgentProxy.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/index.ts | 100% | 100% |  62.5% | 100% |
| packages/fdc3-agent-proxy/src/apps/DefaultAppSupport.ts | 88% | 50% | 100% | 88% |
| packages/fdc3-agent-proxy/src/channels/DefaultChannel.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/channels/DefaultChannelSupport.ts | 98.71% | 100% | 94.44% | 100% |
| packages/fdc3-agent-proxy/src/channels/DefaultPrivateChannel.ts | 97.29% | 66.66% | 100% | 97.29% |
| packages/fdc3-agent-proxy/src/heartbeat/DefaultHeartbeatSupport.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/intents/DefaultIntentResolution.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/intents/DefaultIntentSupport.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/listeners/AbstractListener.ts | 100% | 60% | 100% | 100% |
| packages/fdc3-agent-proxy/src/listeners/DefaultContextListener.ts | 100% | 90% | 100% | 100% |
| packages/fdc3-agent-proxy/src/listeners/DefaultIntentListener.ts | 100% | 77.77% | 100% | 100% |
| packages/fdc3-agent-proxy/src/listeners/EventListener.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/listeners/HeartbeatListener.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/listeners/PrivateChannelEventListener.ts | 93.33% | 72.72% | 100% | 93.33% |
| packages/fdc3-agent-proxy/src/messaging/AbstractMessaging.ts | 94.59% | 100% | 80% | 94.59% |
| packages/fdc3-agent-proxy/src/util/AbstractFDC3Logger.ts | 100% | 94.11% | 100% | 100% |
| packages/fdc3-agent-proxy/src/util/Logger.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-agent-proxy/src/util/throwIfUndefined.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-get-agent/src/index.ts | 100% | 100% |  28.57% | 100% |
| packages/fdc3-get-agent/src/messaging/MessagePortMessaging.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-get-agent/src/messaging/message-port.ts | 97.43% | 86.66% | 100% | 97.43% |
| packages/fdc3-get-agent/src/sessionStorage/DesktopAgentDetails.ts | 97.36% | 89.47% | 100% | 97.36% |
| packages/fdc3-get-agent/src/strategies/DesktopAgentPreloadLoader.ts | 100% | 77.77% | 100% | 100% |
| packages/fdc3-get-agent/src/strategies/FailoverHandler.ts | 100% | 76.47% | 100% | 100% |
| packages/fdc3-get-agent/src/strategies/HelloHandler.ts | 94% | 81.25% | 100% | 94% |
| packages/fdc3-get-agent/src/strategies/IdentityValidationHandler.ts | 95.65% | 73.33% | 100% | 95.65% |
| packages/fdc3-get-agent/src/strategies/PostMessageLoader.ts | 98.48% | 86.95% | 100% | 98.46% |
| packages/fdc3-get-agent/src/strategies/Timeouts.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-get-agent/src/strategies/getAgent.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-get-agent/src/ui/AbstractUIComponent.ts | 97.14% | 71.42% | 100% | 97.01% |
| packages/fdc3-get-agent/src/ui/DefaultDesktopAgentChannelSelector.ts | 100% | 75% | 100% | 100% |
| packages/fdc3-get-agent/src/ui/DefaultDesktopAgentIntentResolver.ts | 100% | 90% | 100% | 100% |
| packages/fdc3-get-agent/src/ui/NullChannelSelector.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-get-agent/src/ui/NullIntentResolver.ts | 100% | 100% | 66.66% | 100% |
| packages/fdc3-get-agent/src/util/Logger.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-get-agent/src/util/Uuid.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/index.ts | 100% | 100% | 0% | 100% |
| packages/fdc3-standard/src/api/Errors.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/api/GetAgent.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/api/Methods.ts | 94.04% | 84.05% | 96.29% | 95% |
| packages/fdc3-standard/src/api/RecommendedChannels.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/context/ContextType.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/intents/Intents.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/internal/contextConfiguration.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/internal/intentConfiguration.ts | 100% | 100% | 100% | 100% |
| packages/fdc3-standard/src/internal/typeHelpers.ts | 100% | 100% | 100% | 100% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/BasicFDC3Server.ts | 100% | 100% | 100% | 100% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/ServerContext.ts | 100% | 100% | 100% | 100% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/directory/BasicDirectory.ts | 96.87% | 84.21% | 100% | 96.55% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/BroadcastHandler.ts | 96.38% | 86.41% | 100% | 96.12% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/HeartbeatHandler.ts | 88.23% | 71.87% | 86.66% | 90% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/IntentHandler.ts | 97.96% | 91.66% | 100% | 97.68% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/OpenHandler.ts | 97.14% | 86.84% | 100% | 97.14% |
| toolbox/fdc3-for-web/fdc3-web-impl/src/handlers/support.ts | 100% | 100% | 100% | 100% |
@Roaders and @julianna-ciq this is merged and if you merge main into your open PRs we should be able to see if this is doing the job.
It seems like this isn't working as expected. I created a new PR from my personal repo and the checks still fail:
https://github.com/finos/FDC3/pull/1630
but unfortunately it looks like the check now fails for PRs from branches in teh fion repo as well:
https://github.com/finos/FDC3/pull/1613
@julianna-ciq this didn't work, apparently PRs run in the context of the receiving repository (which is why giving them write access is dangerous), so the value of github.repository is always "finos/FDC3" for a PR, according to co-pilot anyway:
When you receive a pull request from a fork, the value of github.repository in the GitHub Actions context will be the name of the repository where the workflow is running. This means it will reflect the repository of the upstream (original) repository, not the fork.
For example, if the upstream repository is owner/upstream-repo and the pull request comes from a fork fork-owner/fork-repo, the value of github.repository will be owner/upstream-repo.
This is because workflows triggered by pull requests run in the context of the upstream repository where the pull request is opened.
When asked what you should use, it suggests:
You can use the
github.event.pull_request.head.repo.full_namecontext variable in your GitHub Actions workflow to get the full name of the repository from which the pull request was raised. This includes the owner and repository name of the fork.For example, you can access it in your workflow like this:
- name: Get fork repository name run: echo "Forked from: ${{ github.event.pull_request.head.repo.full_name }}" This will output the name of the forked repository, such as username/repository.