Add support for releaseServerUrl #70
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Ahmed3lmallah
approved these changes
Sep 27, 2024
action.yml
Outdated
| @@ -21,6 +21,9 @@ inputs: | |||
| detectorsFilter: | |||
| description: 'A comma separated list with the identifiers of the specific detectors to be used. This is meant to be used for testing purposes only.' | |||
| required: false | |||
| releaseServerUrl: | |||
| description: 'The baseUrl of the release server to use. If you set this, it should be set to `https://api.github.com`' | |||
There was a problem hiding this comment.
This description is a bit confusing to me: Does it mean that https://api.github.com is the default value, in which case we should change the wording. I don't think it does now that I looked at the code.
Otherwise, if it means that https://api.github.com is the only possible valid value, then we should probably hardcode the url and use a boolean instead to trigger that option.
There was a problem hiding this comment.
Yeah, that is confusing. Let me figure that out and update.
There was a problem hiding this comment.
Ok, I see what the original intent was and I rewrote it so that it should work without setting any configuration options. I'm going to try to test this in a real GHES instance to make sure.
bteng22
approved these changes
Sep 27, 2024
There was a problem hiding this comment.
Mostly LGTM too! Pulled down the branch and ran the tests just in case.
I got this timeout error a couple times but after reloading the codespace I haven't encountered it again. Looks like it might've been an issue with my machine
● Downloads CLI
thrown: "Exceeded timeout of 5000 ms for a test.
Add a timeout value to this test to increase the timeout, if this is a long-running test. See https://jestjs.io/docs/api#testname-fn-timeout."
10 | await ComponentDetection.downloadLatestRelease();
11 | await ComponentDetection.runComponentDetection("./test");
> 12 | expect(fs.existsSync(ComponentDetection.outputPath));
| ^
13 | });
14 |
15 | test("Parses CLI output", async () => {
at componentDetection.test.ts:12:1
|
Thanks @bteng22, I wonder if that was just a weird fluke. I haven't seen that in any of my test runs, nor has it been happening in CI. I've now confirmed that this works in GHES 3.13 and on github.com, so I think it's ready to merge and release. I'll do that on Monday, though, to avoid tempting fate. |
|
Hi juxtin, I tried implementing the action against the latest version Following the release of the new version, v0.0.3 and the conversion here: Fixed-issue, I tried to implement the following on my end: But still end up with the same error as below: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is based on #67, with one additional commit to fix tests. Since @jhutchings1 has sadly moved on to other things, I've taken over this PR to see it through.
Original PR description from #67:
– @jhutchings1
That's the main part of the PR. The part that I added was using
babel-jestto fix the tests. In short, tests were failing because Jest couldn't properly handle ES modules likeoctokitand@github/dependency-submission-toolkit, which are mixed with CommonJS modules in this project. Addingbabel-jestallows Jest to transform those modules on the fly so that they can be used in tests. It has no effect on the actual code.I also removed the configuration option because it only had one possible value and only in one specific case, which I think we can detect automatically. In this version, it should Just Work™ without any intervention.