feat(config): implement custom header field inside HostRules #26225

hersentino · 2023-12-11T10:29:52Z

Changes

Adding a 'headers' field to the 'HostRules' configuration, which will be automatically included in the HTTP request header.

Context

I'm making this change because the URL (matchHost) from which I want to retrieve the package version has an authentication system using "X-Auth-Token." Currently, there is no way to pass the token. I came across this discussion that also reports the problem. However, the proposed solution in the discussion cannot work according to the source code. This solution enables genericity

closes Allow to set headers using hostRules #26625

Documentation (please check one with an [x])

I have updated the documentation, or
No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

Code inspection only, or
Newly added/modified unit tests, or
No unit tests but ran on a real repository, or
Both unit tests + ran on a real repository

CLAassistant · 2023-12-11T10:29:58Z

All committers have signed the CLA.

rarkins

Needs discussion about validation and security

lib/util/http/host-rules.ts

rarkins

Should be a new globalOnly config option allowedHeaders in lib/config/options

hersentino · 2023-12-19T08:05:39Z

@rarkins, I've made the changes. Can you confirm if it's okay with you? Sorry for the accidental close/open; it was a misclick

rarkins

Please make use of the anyMatchRegexOrMinimatch() function and do not convert into RegExp internally

lib/types/host-rules.ts

docs/usage/self-hosted-configuration.md

lib/config/options/index.ts

rarkins

Please also check that Renovate validates (enforces) that the config (header values must be a string)

docs/usage/self-hosted-configuration.md

lib/config/options/index.ts

lib/types/host-rules.ts

lib/util/http/host-rules.ts

rarkins

Actually, I think it's essential that we validate repo config for allowed headers and raise a config error if any don't match (instead of waiting until runtime to log a warning)

lib/config/migrations/custom/host-rules-migration.ts

docs/usage/configuration-options.md

docs/usage/self-hosted-configuration.md

lib/config/options/index.ts

lib/config/validation.ts

hersentino · 2023-12-22T15:15:13Z

I added tests to resolve code coverage issues. Could you please rerun the pipeline ?

lib/config/validation.ts

lib/util/http/host-rules.ts

hersentino · 2024-01-03T12:35:24Z

@rarkins Could you please rerun the pipeline ?

lib/config/validation.spec.ts

rarkins · 2024-01-17T08:16:47Z

@hersentino I think you need to merge from main branch again before this can be successfully merged

renovate-release · 2024-01-17T09:43:02Z

🎉 This PR is included in version 37.139.0 🎉

The release is available on:

GitHub release
37.139.0

Your semantic-release bot 📦🚀

…ebot#26225)

hersentino force-pushed the implement-custom-headers-2 branch 2 times, most recently from ffc40b4 to 9e9d5ff Compare December 11, 2023 10:55

hersentino changed the title ~~Implement custom headers field inside HostRules~~ feat(config): implement custom headers field inside HostRules Dec 11, 2023

rarkins reviewed Dec 11, 2023

View reviewed changes

lib/util/http/host-rules.ts Outdated Show resolved Hide resolved

rarkins requested changes Dec 15, 2023

View reviewed changes

hersentino force-pushed the implement-custom-headers-2 branch 3 times, most recently from 3c476e9 to 23e79b9 Compare December 18, 2023 16:32

hersentino closed this Dec 19, 2023

hersentino reopened this Dec 19, 2023

rarkins requested changes Dec 19, 2023

View reviewed changes

hersentino force-pushed the implement-custom-headers-2 branch from 5c46d9f to fe3faf5 Compare December 19, 2023 16:05

rarkins requested changes Dec 19, 2023

View reviewed changes

lib/types/host-rules.ts Outdated Show resolved Hide resolved

docs/usage/self-hosted-configuration.md Outdated Show resolved Hide resolved

lib/config/options/index.ts Outdated Show resolved Hide resolved

rarkins requested changes Dec 20, 2023

View reviewed changes

lib/config/migrations/custom/host-rules-migration.ts Outdated Show resolved Hide resolved

rarkins requested changes Dec 22, 2023

View reviewed changes

viceice reviewed Dec 26, 2023

View reviewed changes

viceice reviewed Jan 8, 2024

View reviewed changes

lib/config/validation.spec.ts Outdated Show resolved Hide resolved

lib/config/validation.spec.ts Outdated Show resolved Hide resolved

hersentino force-pushed the implement-custom-headers-2 branch from bc1a14d to dd9a775 Compare January 9, 2024 08:08

hersentino added 6 commits January 9, 2024 09:16

feat: add header support

b4b996b

feat: add allowedHeaders

1fd9eb4

fix: remove useless change

8936086

fix: use anyMatchRegexOrMinimatch

13436e2

fix: review

fd45f0f

fix: review

61d280c

fix: revert header/allowedHeader

8815f1c

hersentino force-pushed the implement-custom-headers-2 branch from 627e221 to 8815f1c Compare January 16, 2024 09:53

rarkins previously approved these changes Jan 16, 2024

View reviewed changes

rarkins requested review from viceice, rarkins and HonkingGoose January 16, 2024 09:57

viceice previously approved these changes Jan 16, 2024

View reviewed changes

viceice added this pull request to the merge queue Jan 16, 2024

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 16, 2024

rarkins added this pull request to the merge queue Jan 16, 2024

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 16, 2024

rarkins added this pull request to the merge queue Jan 16, 2024

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 16, 2024

hersentino and others added 2 commits January 17, 2024 09:21

Merge branch 'main' into implement-custom-headers-2

b491660

fix: validateConfig calls

10dba48

hersentino dismissed stale reviews from rarkins and viceice via 10dba48 January 17, 2024 08:45

viceice approved these changes Jan 17, 2024

View reviewed changes

viceice enabled auto-merge January 17, 2024 08:50

viceice added this pull request to the merge queue Jan 17, 2024

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 17, 2024

viceice added this pull request to the merge queue Jan 17, 2024

Merged via the queue into renovatebot:main with commit db9d485 Jan 17, 2024
36 checks passed

zT-1337 pushed a commit to scm-manager/renovate that referenced this pull request Jan 22, 2024

feat(config): implement custom header field inside HostRules (renovat…

cccdd34

…ebot#26225)

zT-1337 pushed a commit to scm-manager/renovate that referenced this pull request Jan 24, 2024

feat(config): implement custom header field inside HostRules (renovat…

936e522

…ebot#26225)

zT-1337 pushed a commit to scm-manager/renovate that referenced this pull request Jan 24, 2024

feat(config): implement custom header field inside HostRules (renovat…

e92fd4e

…ebot#26225)

github-actions bot locked as resolved and limited conversation to collaborators Feb 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(config): implement custom header field inside HostRules #26225

feat(config): implement custom header field inside HostRules #26225

hersentino commented Dec 11, 2023 •

edited by viceice

Loading

CLAassistant commented Dec 11, 2023 •

edited

Loading

rarkins left a comment

rarkins left a comment

hersentino commented Dec 19, 2023

rarkins left a comment

rarkins left a comment

rarkins left a comment

hersentino commented Dec 22, 2023

hersentino commented Jan 3, 2024

rarkins commented Jan 17, 2024

renovate-release commented Jan 17, 2024

feat(config): implement custom header field inside HostRules #26225

feat(config): implement custom header field inside HostRules #26225

Conversation

hersentino commented Dec 11, 2023 • edited by viceice Loading

Changes

Context

Documentation (please check one with an [x])

How I've tested my work (please select one)

CLAassistant commented Dec 11, 2023 • edited Loading

rarkins left a comment

Choose a reason for hiding this comment

rarkins left a comment

Choose a reason for hiding this comment

hersentino commented Dec 19, 2023

rarkins left a comment

Choose a reason for hiding this comment

rarkins left a comment

Choose a reason for hiding this comment

rarkins left a comment

Choose a reason for hiding this comment

hersentino commented Dec 22, 2023

hersentino commented Jan 3, 2024

rarkins commented Jan 17, 2024

renovate-release commented Jan 17, 2024

hersentino commented Dec 11, 2023 •

edited by viceice

Loading

CLAassistant commented Dec 11, 2023 •

edited

Loading