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.

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

fix: Clarifying sources that support Terraform Dependency Updates #30139

Merged
merged 23 commits into from Dec 1, 2023

Conversation

CBID2
Copy link
Contributor

@CBID2 CBID2 commented Nov 21, 2023

Why:

This PR clarifies sources that support Terraform Dependency Updates. This change would help maintainers gain a better understanding on how to work with this feature.

Closes #8419

What's being changed (if available, include any code snippets, screenshots, or gifs):

So far, I did the following:

Supported repositories and ecosystems" section of About Dependabot version updates

  • Update the introduction to mention that dependencies in private registeries are also supported (similar to the mention of vendored dependencies).
  • Update the link to the article with configuration options - link to both the #vendor anchor and also the #registries anchor.

"package-ecosystem" section of Configuration options for dependency updates

  • Add a brief sentence, similar to that for vendor mentioning private registries and linking to registries.

"Configuration options for private registries" section of Configuration options for dependency updates

  • Add a brief sentence to the first paragraph, mentioning that you can give Dependabot access to private package registries hosted by GitLab or Bitbucket by specifying a type of git and linking to git.

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline.

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Nov 21, 2023
Copy link
Contributor

github-actions bot commented Nov 21, 2023

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates.md fpt
ghec
ghes@ 3.11 3.10 3.9 3.8 3.7
fpt
ghec
ghes@ 3.11 3.10 3.9 3.8 3.7
code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md fpt
ghec
ghes@ 3.11 3.10 3.9 3.8 3.7
fpt
ghec
ghes@ 3.11 3.10 3.9 3.8 3.7

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server
ghae: GitHub AE

@janiceilene
Copy link
Contributor

Thanks so much for taking this on @CBID2! Let us know when you're ready for a review ⚡

@CBID2
Copy link
Contributor Author

CBID2 commented Nov 22, 2023

Thanks so much for taking this on @CBID2! Let us know when you're ready for a review ⚡

Hi @janiceilene. I'm struggling with this particular part:

"package-ecosystem" section of Configuration options for dependency updates

  • Add a brief sentence, similar to that for vendor mentioning private registries and linking to registries.

I'm not sure what to put as a sentence and the Markdown issue that I'm having. Can you help me? :)

@janiceilene janiceilene added content This issue or pull request belongs to the Docs Content team code security Content related to code security labels Nov 23, 2023
@mchammer01 mchammer01 self-requested a review November 23, 2023 13:36
@mchammer01
Copy link
Contributor

I'll take a look at this (probably tomorrow) ⚡

@am-stead
Copy link
Contributor

👋 @CBID2,

I'm not sure what to put as a sentence and the Markdown issue that I'm having. Can you help me? :)

I think something like this would be sufficient?

If you want to allow {% data variables.product.prodname_dependabot %} to access a private package registry when performing a version update, you can include a registries setting in the configuration file. For more information, see [registries](#registries) below.

Co-authored-by: Anne-Marie  <102995847+am-stead@users.noreply.github.com>
@CBID2
Copy link
Contributor Author

CBID2 commented Nov 24, 2023

👋 @CBID2,

I'm not sure what to put as a sentence and the Markdown issue that I'm having. Can you help me? :)

I think something like this would be sufficient?

If you want to allow {% data variables.product.prodname_dependabot %} to access a private package registry when performing a version update, you can include a registries setting in the configuration file. For more information, see [registries](#registries) below.

Made the edit @am-stead

@am-stead
Copy link
Contributor

Hi @CBID2

I'm not seeing an edit / a File changed for this update?
(For the suggestion above)

"package-ecosystem" section of Configuration options for dependency updates

  • Add a brief sentence, similar to that for vendor mentioning private registries and linking to registries.

@CBID2
Copy link
Contributor Author

CBID2 commented Nov 24, 2023

Hi @CBID2

I'm not seeing an edit / a File changed for this update?

(For the suggestion above)

"package-ecosystem" section of Configuration options for dependency updates

  • Add a brief sentence, similar to that for vendor mentioning private registries and linking to registries.

Ooh ok

@CBID2 CBID2 marked this pull request as ready for review November 29, 2023 20:48
@CBID2
Copy link
Contributor Author

CBID2 commented Nov 29, 2023

Hi @CBID2

I'm not seeing an edit / a File changed for this update? (For the suggestion above)

"package-ecosystem" section of Configuration options for dependency updates

  • Add a brief sentence, similar to that for vendor mentioning private registries and linking to registries.

Hi @am-stead! :) I made the changes! :)

@am-stead
Copy link
Contributor

👋 @CBID2,
Thanks so much for pushing those new changes. It's looking great!
I've left a couple of final suggestions to bring the changes in line with the issue, and then I think it will be ready to ship! ✨

CBID2 and others added 6 commits November 30, 2023 10:28
Co-authored-by: Anne-Marie  <102995847+am-stead@users.noreply.github.com>
Co-authored-by: Anne-Marie  <102995847+am-stead@users.noreply.github.com>
@CBID2
Copy link
Contributor Author

CBID2 commented Nov 30, 2023

Hi @am-stead! :) I made the necessary changes! :)

…nfiguration-options-for-the-dependabot.yml-file.md
Copy link
Contributor

@am-stead am-stead left a comment

Choose a reason for hiding this comment

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

👋 @CBID2,

This looks great! ✨

I just pushed a couple of commits to resolve a failing test and align the link text.
But as soon as I see that the tests are all now passing, I'll get it merged! 🚀

Thank you so much for contributing to the docs! 💖

@am-stead am-stead added this pull request to the merge queue Dec 1, 2023
Merged via the queue into github:main with commit b3a5e14 Dec 1, 2023
43 checks passed
Copy link
Contributor

github-actions bot commented Dec 1, 2023

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code security Content related to code security content This issue or pull request belongs to the Docs Content team triage Do not begin working on this issue until triaged by the team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarify what all sources are supported for Terraform Dependency Updates
4 participants