diff --git a/.github/dependabot.yml b/.github/dependabot.yml index f21fa1ace..f624e4dec 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,7 +1,7 @@ # To get started with Dependabot version updates, you'll need to specify which # package ecosystems to update and where the package manifests are located. # Please see the documentation for all configuration options: -# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates +# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file version: 2 updates: diff --git a/CODEOWNERS b/CODEOWNERS index 79ccf045f..42dcc0c93 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -1,3 +1,3 @@ -# https://help.github.com/articles/about-codeowners/ +# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners # These owners will be the default owners for everything in the repo. * @runatlantis/maintainers diff --git a/runatlantis.io/docs/access-credentials.md b/runatlantis.io/docs/access-credentials.md index 3dcb8c128..ab9cc137d 100644 --- a/runatlantis.io/docs/access-credentials.md +++ b/runatlantis.io/docs/access-credentials.md @@ -24,7 +24,7 @@ generate an access token. Read on for the instructions for your specific Git hos * [Azure DevOps](#azure-devops) ### GitHub user -- Create a Personal Access Token by following: [https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/#creating-a-token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/#creating-a-token) +- Create a Personal Access Token by following: [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#creating-a-token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#creating-a-token) - Create the token with **repo** scope - Record the access token ::: warning diff --git a/runatlantis.io/docs/apply-requirements.md b/runatlantis.io/docs/apply-requirements.md index 121861624..e3a779a9d 100644 --- a/runatlantis.io/docs/apply-requirements.md +++ b/runatlantis.io/docs/apply-requirements.md @@ -34,7 +34,7 @@ You can set the `approved` requirement by: - id: /.*/ allowed_overrides: [apply_requirements] ``` - + #### atlantis.yaml ```yaml version: 3 @@ -69,7 +69,7 @@ You can set the `mergeable` requirement by: - id: /.*/ apply_requirements: [mergeable] ``` - + 1. Or by allowing an `atlantis.yaml` file to specify the `apply_requirements` key in your `repos.yaml` config: #### repos.yaml ```yaml @@ -77,7 +77,7 @@ You can set the `mergeable` requirement by: - id: /.*/ allowed_overrides: [apply_requirements] ``` - + #### atlantis.yaml ```yaml version: 3 @@ -85,7 +85,7 @@ You can set the `mergeable` requirement by: - dir: . apply_requirements: [mergeable] ``` - + #### Meaning Each VCS provider has a different concept of "mergeability": @@ -96,7 +96,7 @@ See also the `branch` keyword in [Server Side Repo Config](server-side-repo-conf ::: #### GitHub -In GitHub, if you're not using [Protected Branches](https://help.github.com/articles/about-protected-branches/) then +In GitHub, if you're not using [Protected Branches](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches) then all pull requests are mergeable unless there is a conflict. If you set up Protected Branches then you can enforce: @@ -105,7 +105,7 @@ If you set up Protected Branches then you can enforce: * Requiring `CODEOWNERS` to have reviewed and approved the pull request * Requiring that the branch is up to date with `master` -See [https://help.github.com/articles/about-protected-branches/](https://help.github.com/articles/about-protected-branches/) +See [https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches) for more details. ::: warning @@ -143,7 +143,7 @@ At this time, the Azure DevOps client only supports merging using the default 'n ::: ### UnDiverged -Prevent applies if there are any changes on the base branch since the most recent plan. +Prevent applies if there are any changes on the base branch since the most recent plan. Applies to `merge` checkout strategy only. #### Usage @@ -170,11 +170,11 @@ You can set the `undiverged` requirement by: apply_requirements: [undiverged] ``` #### Meaning -The `merge` checkout strategy creates a temporary merge commit and runs the `plan` on the Atlantis local version of the PR -source and destination branch. The local destination branch can become out of date since changes to the destination branch are not fetched -if there are no changes to the source branch. `undiverged` enforces that Atlantis local version of master is up to date -with remote so that the state of the source during the `apply` is identical to that if you were to merge the PR at that -time. +The `merge` checkout strategy creates a temporary merge commit and runs the `plan` on the Atlantis local version of the PR +source and destination branch. The local destination branch can become out of date since changes to the destination branch are not fetched +if there are no changes to the source branch. `undiverged` enforces that Atlantis local version of master is up to date +with remote so that the state of the source during the `apply` is identical to that if you were to merge the PR at that +time. ## Setting Apply Requirements As mentioned above, you can set apply requirements via flags, in `repos.yaml`, or in `atlantis.yaml` if `repos.yaml` @@ -207,7 +207,7 @@ If you only want some projects/repos to have apply requirements, then you must 1. Specify which projects have which requirements via an `atlantis.yaml` file, and allowing `apply_requirements` to be set in in `atlantis.yaml` by the server side `repos.yaml` config. - + For example if I have two directories, `staging` and `production`, I might use: #### repos.yaml ```yaml @@ -216,7 +216,7 @@ If you only want some projects/repos to have apply requirements, then you must allowed_overrides: [apply_requirements] # Allow any repo to specify apply_requirements in atlantis.yaml ``` - + #### atlantis.yaml ```yaml version: 3 @@ -239,7 +239,7 @@ Once the apply requirement is satisfied, **anyone** that can comment on the pull request can run the actual `atlantis apply` command. ## Next Steps -* For more information on GitHub pull request reviews and approvals see: [https://help.github.com/articles/about-pull-request-reviews/](https://help.github.com/articles/about-pull-request-reviews/) +* For more information on GitHub pull request reviews and approvals see: [https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews) * For more information on GitLab merge request reviews and approvals (only supported on GitLab Enterprise) see: [https://docs.gitlab.com/ee/user/project/merge_requests/merge_request_approvals.html](https://docs.gitlab.com/ee/user/project/merge_requests/merge_request_approvals.html). * For more information on Bitbucket pull request reviews and approvals see: [https://confluence.atlassian.com/bitbucket/pull-requests-and-code-review-223220593.html](https://confluence.atlassian.com/bitbucket/pull-requests-and-code-review-223220593.html) * For more information on Azure DevOps pull request reviews and approvals see: [https://docs.microsoft.com/en-us/azure/devops/repos/git/pull-requests?view=azure-devops&tabs=browser](https://docs.microsoft.com/en-us/azure/devops/repos/git/pull-requests?view=azure-devops&tabs=browser) diff --git a/runatlantis.io/docs/server-configuration.md b/runatlantis.io/docs/server-configuration.md index f9e3db3dd..70c786ba1 100644 --- a/runatlantis.io/docs/server-configuration.md +++ b/runatlantis.io/docs/server-configuration.md @@ -326,7 +326,7 @@ Values are chosen in this order: ```bash atlantis server --gh-app-id="00000" ``` - GitHub app ID. If set, GitHub authentication will be performed as [an installation](https://docs.github.com/en/rest/reference/apps#installations). + GitHub app ID. If set, GitHub authentication will be performed as [an installation](https://docs.github.com/en/rest/apps/installations). ::: tip A GitHub app can be created by starting Atlantis first, then pointing your browser at @@ -348,7 +348,7 @@ Values are chosen in this order: ```bash atlantis server --gh-app-key-file="path/to/app-key.pem" ``` - Path to a GitHub App PEM encoded private key file. If set, GitHub authentication will be performed as [an installation](https://docs.github.com/en/rest/reference/apps#installations). + Path to a GitHub App PEM encoded private key file. If set, GitHub authentication will be performed as [an installation](https://docs.github.com/en/rest/apps/installations). - ### `--gh-app-key` ```bash diff --git a/runatlantis.io/guide/testing-locally.md b/runatlantis.io/guide/testing-locally.md index e0aee3367..4fdc45ee9 100644 --- a/runatlantis.io/guide/testing-locally.md +++ b/runatlantis.io/guide/testing-locally.md @@ -147,7 +147,7 @@ you can use your own user. Here we'll create the access token that Atlantis uses set commit statuses. ### GitHub or GitHub Enterprise Access Token -- follow [https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/#creating-a-token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/#creating-a-token) +- follow [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#creating-a-token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#creating-a-token) - create a token with **repo** scope - set the token as an environment variable ``` @@ -312,7 +312,7 @@ Atlantis at a specific plan. Otherwise it tries to apply the plan for the root d ## Real-time logs The [real-time terraform output](/docs/streaming-logs.md) for your command can be found by clicking into the status check for a given project in a PR which -links to the log-streaming UI. This is a terminal UI where you can view your commands executing in real-time. +links to the log-streaming UI. This is a terminal UI where you can view your commands executing in real-time. ## Next Steps * If things are working as expected you can `Ctrl-C` the `atlantis server` command and the `ngrok` command. diff --git a/server/events/command/context.go b/server/events/command/context.go index 0e2ba7d9e..968551b99 100644 --- a/server/events/command/context.go +++ b/server/events/command/context.go @@ -23,7 +23,7 @@ type Context struct { // HeadRepo is the repository that is getting merged into the BaseRepo. // If the pull request branch is from the same repository then HeadRepo will // be the same as BaseRepo. - // See https://help.github.com/articles/about-pull-request-merges/. + // See https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges HeadRepo models.Repo Pull models.PullRequest Scope tally.Scope diff --git a/testdrive/testdrive.go b/testdrive/testdrive.go index 8ad0d1f86..ecb0202be 100644 --- a/testdrive/testdrive.go +++ b/testdrive/testdrive.go @@ -97,7 +97,7 @@ To continue, we need you to create a GitHub personal access token with [green]"repo" [reset]scope so we can fork an example terraform project. Follow these instructions to create a token (we don't store any tokens): -[green]https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/#creating-a-token[reset] +[green]https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#creating-a-token[reset] - use "atlantis" for the token description - add "repo" scope - copy the access token