Add github action to docs #31825
Add github action to docs #31825
Conversation
Preview links (active after the
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v5 | ||
| - name: Deploy Canary | ||
| run: | |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
content/en/deployment_gates/setup.md
Outdated
|
|
||
| {{% /tab %}} | ||
| {{% tab "GitHub Actions" %}} | ||
| Datadog provides a GitHub Action to integrate with Deployment Gates: |
There was a problem hiding this comment.
I'm missing a bit more of an introduction to the action, and then introduce them to an example of how it could be used:
| Datadog provides a GitHub Action to integrate with Deployment Gates: | |
| The [`Datadog Deployment Gate GitHub Action`][4] includes all the required logic to evaluate a Deployment Gate during the deployment of a service. | |
| Add a `DataDog/deployment-gate-github-action` step to your existing deployment workflow, for example: |
content/en/deployment_gates/setup.md
Outdated
| - name: Checkout | ||
| uses: actions/checkout@v5 |
There was a problem hiding this comment.
Is checking out the code needed for this? I would simplify this as just the 'Deploy Canary' step you outlined below
content/en/deployment_gates/setup.md
Outdated
| * `DD_API_KEY`: Your [Datadog API key][2], used to authenticate the requests. | ||
| * `DD_APP_KEY`: Your [Datadog application key][3], used to authenticate the requests. | ||
|
|
||
| For complete configuration options and detailed usage examples, see the [`deployment-gate-action` repository][4]. |
There was a problem hiding this comment.
| For complete configuration options and detailed usage examples, see the [`deployment-gate-action` repository][4]. | |
| For complete configuration options and detailed usage examples, see the [`Datadog/deployment-gate-github-action` repository][4]. |
content/en/deployment_gates/setup.md
Outdated
| * `DD_API_KEY`: Your [Datadog API key][2], used to authenticate the requests. | ||
| * `DD_APP_KEY`: Your [Datadog application key][3], used to authenticate the requests. |
There was a problem hiding this comment.
nit: Datadog could be a bit redundant here
| * `DD_API_KEY`: Your [Datadog API key][2], used to authenticate the requests. | |
| * `DD_APP_KEY`: Your [Datadog application key][3], used to authenticate the requests. | |
| * `DD_API_KEY`: Your [API key][2], used to authenticate the requests. | |
| * `DD_APP_KEY`: Your [Application key][3], used to authenticate the requests. |
content/en/deployment_gates/setup.md
Outdated
| # Your deployment commands here | ||
| ``` | ||
|
|
||
| The GitHub action wraps around the [`datadog-ci` command][1], and as such has the same behavior, parameters and requirements. |
There was a problem hiding this comment.
Even though it's a bit of repetition, I don't expect users to click here to go to the datadog-ci documentation. I think it doesn't hurt copy-pasting the details from the tab before:
| The GitHub action wraps around the [`datadog-ci` command][1], and as such has the same behavior, parameters and requirements. | |
| If the Deployment Gate being evaluated contains APM Faulty Deployment Detection rules, you must also specify the version (for example, `version: 1.0.1`). | |
| The command has the following behavior: | |
| * It sends a request to start the gate evaluation and blocks until the evaluation is complete. | |
| * It provides a configurable timeout to determine the maximum amount of time to wait for an evaluation to complete. | |
| * It has built-in automatic retries for errors. | |
| * It allows you to customize its behavior in case of unexpected Datadog errors with the `fail-on-error` parameter. |
|
/merge |
|
View all feedbacks in Devflow UI.
Added to the queue but the mergequeue is not enabled for now. Use ⏳ Processing |
What does this PR do? What is the motivation?
Adds new github action docs to deployment gates
Merge instructions
Merge readiness:
For Datadog employees:
Your branch name MUST follow the
<name>/<description>convention and include the forward slash (/). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.If your branch doesn't follow this format, rename it or create a new branch and PR.
[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.
Additional notes