Skip to content

Commit

Permalink
Merge pull request #2532 from newrelic/release
Browse files Browse the repository at this point in the history
Release - 09/05/2024
  • Loading branch information
aswanson-nr authored Sep 5, 2024
2 parents 5d866ee + 3da06ab commit ce64627
Show file tree
Hide file tree
Showing 760 changed files with 2,619 additions and 7,864 deletions.
44 changes: 10 additions & 34 deletions .github/workflows/reusable.quickstart_submission.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Reusable workflow for creating, updating, or validating quickstarts and install plans for a single environment.
# Reusable workflow for creating, updating, or validating quickstarts for a single environment.
name: Quickstart submission

on:
Expand Down Expand Up @@ -26,30 +26,6 @@ env:
DRY_RUN: ${{ inputs.dry-run }}

jobs:
submit-install-plans:
name: Submit install plans
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
# Ensure we have the most recent commit to `main`
with:
ref: "main"
fetch-depth: 0

- name: Setup workspace
uses: "./.github/actions/bootstrap"

- name: Update install plans
env:
NR_API_URL: ${{ secrets.nr-api-url }}
NR_API_TOKEN: ${{ secrets.nr-api-token }}
GITHUB_TOKEN: ${{ secrets.github-token }}
NEW_RELIC_LICENSE_KEY: ${{ secrets.nr-license-key }}
run: |
URL="https://api.github.com/repos/${GITHUB_REPOSITORY}/pulls/$PR_NUMBER/files"
cd utils && yarn create-validate-install-plans "$URL" "$DRY_RUN"
submit-data-sources:
name: Submit data sources
runs-on: ubuntu-latest
Expand All @@ -58,11 +34,11 @@ jobs:
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
# Ensure we have the most recent commit to `main`
with:
ref: "main"
ref: 'main'
fetch-depth: 0

- name: Setup workspace
uses: "./.github/actions/bootstrap"
uses: './.github/actions/bootstrap'

- name: Update data sources
env:
Expand All @@ -75,19 +51,19 @@ jobs:
cd utils && yarn create-validate-data-sources "$URL" "$DRY_RUN"
submit-quickstarts:
needs: [submit-install-plans, submit-data-sources]
needs: [submit-data-sources]
name: Submit quickstarts
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
# Ensure we have the most recent commit to `main`
with:
ref: "main"
ref: 'main'
fetch-depth: 0

- name: Setup workspace
uses: "./.github/actions/bootstrap"
uses: './.github/actions/bootstrap'

- name: Update quickstarts
env:
Expand All @@ -108,11 +84,11 @@ jobs:
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
# Ensure we have the most recent commit to `main`
with:
ref: "main"
ref: 'main'
fetch-depth: 0

- name: Setup workspace
uses: "./.github/actions/bootstrap"
uses: './.github/actions/bootstrap'

- name: Update dashboards with required datasources from quickstarts
env:
Expand All @@ -133,11 +109,11 @@ jobs:
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
# Ensure we have the most recent commit to `main`
with:
ref: "main"
ref: 'main'
fetch-depth: 0

- name: Setup workspace
uses: "./.github/actions/bootstrap"
uses: './.github/actions/bootstrap'

- name: Update dashboards with required datasources from quickstarts
env:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/submit-gate.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This looks like a confusing workflow, but it has a purpose (✿ ◕‿◕)
# It functions kind of as a workflow shim. We can't setup other important workflows to run on pull_request (due to forks), so we setup this workflow to be triggered by pull_request and it is always able to run.
# When it is finished running, it triggers the other important workflows -- submit_packs, submit_install_plans.
# When it is finished running, it triggers the other important workflows -- submit_packs, etc.
# Having it setup this way allows us to have manual approval for this workflow run, and then the subsequent triggered runs can access secrets in the repository for validation (even for forked PRs).
name: Submit Gate

Expand Down
55 changes: 0 additions & 55 deletions .github/workflows/validate_install_plans.yml

This file was deleted.

40 changes: 0 additions & 40 deletions .github/workflows/validate_packs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -163,46 +163,6 @@ jobs:
statusContext: "Validation / Validate Quickstart Schema"
state: ${{ job.status }}

validate-install-plan-ids:
name: Validate install plan ids
runs-on: ubuntu-latest
steps:
- name: Download artifact
uses: dawidd6/action-download-artifact@268677152d06ba59fcec7a7f0b5d961b6ccd7e1e
with:
workflow: validation_gate.yml
run_id: ${{ github.event.workflow_run.id }}

- name: Get PR number
id: get_pr_number
run: |
export PR_NUMBER=$(cat artifact/pr_number.txt)
echo "pr-number=$PR_NUMBER" >> $GITHUB_ENV
- name: Checkout repository
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
with:
ref: "refs/pull/${{ env.pr-number }}/merge"

- name: Setup workspace
uses: "./.github/actions/bootstrap"

- name: Validate new files
id: validation
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PR_NUMBER: ${{ env.pr-number }}
run: |
URL="https://api.github.com/repos/${GITHUB_REPOSITORY}/pulls/$PR_NUMBER/files"
cd utils && yarn validate-quickstart-install-plans "$URL"
- name: Add commit status
if: always()
uses: "./.github/actions/add-commit-status"
with:
statusContext: "Validation / Install plan ids exist"
state: ${{ job.status }}

validate-data-source-ids:
name: Validate data source ids
runs-on: ubuntu-latest
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/validation_gate.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This looks like a confusing workflow, but it has a purpose (✿ ◕‿◕)
# It functions kind of as a workflow shim. We can't setup other important workflows to run on pull_request (due to forks), so we setup this workflow to be triggered by pull_request and it is always able to run.
# When it is finished running, it triggers the other important workflows -- validate_packs, validate_install_plans.
# When it is finished running, it triggers the other important workflows -- validate_packs, etc.
# Having it setup this way allows us to have manual approval for this workflow run, and then the subsequent triggered runs can access secrets in the repository for validation (even for forked PRs).
name: Validation Gate

Expand Down
30 changes: 3 additions & 27 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,9 @@
- [Dashboard name uniqueness](#dashboard-name-uniqueness)
- [Dashboard screenshots](#dashboard-screenshots)
- [Alerts](#alerts)

- [Alert condition fields](#alert-condition-fields)
- [Install Plans (DEPRECATED)](#install-plans-deprecated)

- [Data sources](#data-sources-1)
- [Data source fields](#data-source-fields)
- [Data source install fields](#data-source-install-fields)
Expand Down Expand Up @@ -116,7 +117,7 @@ title: Example quickstart

description: |
## Long form description
* with
* with
* markdown
* support
Expand Down Expand Up @@ -560,31 +561,6 @@ example-alert-condition2.yml

For documentation on the rest of the alert condition fields, please review the [Introduction to alerts](https://docs.newrelic.com/docs/alerts-applied-intelligence/new-relic-alerts/learn-alerts/introduction-alerts)

### Install plans **(DEPRECATED)**

Install plans are now deprecated in favor of using data sources. To learn about data sources and their fields, view the [data sources section](#data-sources-1) below. If you are migrating from install plans to data sources, the following fields can be used equivalently on data sources when creating a COMMUNITY data source. The fields `title` and `target` do not have an equivalent on data sources.

| Install plan field | Data souce field |
| ------------------- | ----------------------------------------------------------------- |
| id | `id` |
| name | `displayName` |
| description | `description` |
| install | `install` |
| install.mode | `install.primary.nerdlet` or `install.primary.link` † |
| install.destination | `install.primary.nerdlet.nerdletId` or `install.primary.link.url` |
| fallback | `install.fallback` |

† _The `install.primary` or `install.fallback` field on data source does not support `targetedInstall`. We are deprecating the use of targeted installs in favor of using CORE data sources. You can learn more about CORE data sources under the [data sources section](#data-sources-1). If you are currently using a targeted install mode and need help with converting a targeted install plan to a CORE data source, please reach out to our team for assistance._

_Example of targeted install:_

```yaml
install:
mode: targetedInstall
destination:
recipeName: fake-install-recipe
```

### Data sources

Data sources represent a _single_ type of instrumentation, such as an agent, attributes on a transaction, a cloud provider integration, a third-party integration, etc.
Expand Down
Loading

0 comments on commit ce64627

Please sign in to comment.