Add auto-layer-releases flow to deploy flow #1274

hmstepanek · 2024-12-16T20:15:19Z

Overview

Move auto-layer-releases flow from lambda to GHA.

github-actions · 2024-12-16T20:16:34Z

🦙 MegaLinter status: ✅ SUCCESS

Descriptor	Linter	Files	Fixed	Elapsed time
✅ YAML	prettier	1	0	0.43s
✅ YAML	v8r	1		2.69s
✅ YAML	yamllint	1		0.26s

See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by

.github/workflows/deploy-python.yml

codecov-commenter · 2024-12-16T20:50:00Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.61%. Comparing base (4c06d26) to head (0988d57).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1274      +/-   ##
==========================================
- Coverage   79.68%   79.61%   -0.07%     
==========================================
  Files         201      201              
  Lines       22174    22174              
  Branches     3519     3519              
==========================================
- Hits        17669    17654      -15     
- Misses       3355     3363       +8     
- Partials     1150     1157       +7

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

TimPansino · 2024-12-16T20:55:35Z

.github/scripts/releases.py

@@ -0,0 +1,70 @@
+#!/bin/bash


Suggested change

#!/bin/bash

#!/usr/bin/env python3

TimPansino · 2024-12-16T20:57:15Z

.github/scripts/releases.py

+# How to use this script:
+# Set the following env vars:
+#   * GH_RELEASE_TOKEN
+#   * LAMBDA_RUNTIME (optional)
+#   * INITCONTAINER_RUNTIME (optional)
+#   * AGENT_VERSION
+#   * DRY_RUN (optional) set to 1 to run the flow without creating the release tag.
+#
+# Lambda runtime options:
+# nodejs
+# python
+# ruby
+# dotnet
+#
+# Initcontainer runtime options:
+# nodejs
+# python
+# ruby
+# java
+# dotnet


Why don't you make those a constant, so we don't have to set those as env vars? Presumably each repo will have a separate copy of this script.

Well...I was still thinking of making it shared at this point (even though I realize I haven't done that in this PR). I guess TBD on that.

TimPansino · 2024-12-16T21:04:27Z

.github/scripts/releases.py

+    tag_name = f"{latest_version}.0_{runtime}"
+    release_name = f"New Relic {runtime} Agent {latest_version}.0"


This originally had logic to have release names and release tags as different strings. For Python the only difference was capitalization, but for Node and .NET it was Node -> nodejs, and .NET -> dotnet.

Why not make constants for TAG_SUFFIX="python" and RUNTIME_NAME="Python". Then maybe use bool constants to toggle on/off the lambda and initcontainer releases?

oooh you're totally right! I was trying to simplify those out but they were used for the release name-I'll put those back I guess. Instead of a boolean I was thinking each team could just set the value of those and that way the work flow could be shared across all teams-I need to look into that more though to see if we can do that.

TimPansino · 2024-12-16T21:09:57Z

As a general thought, is there a reason not to convert this to bash scripting and use the gh CLI? Seems like it would be easier for other teams to manage, and we could then just add the code directly into the release flow as a step.

hmstepanek · 2024-12-17T22:24:27Z

As a general thought, is there a reason not to convert this to bash scripting and use the gh CLI? Seems like it would be easier for other teams to manage, and we could then just add the code directly into the release flow as a step.

I was actually thinking about this after I pushed this up as a Python script. Since we seem to both have had that thought, I'll just go ahead and do that. I agree-it would be easier to maintain that way for each team in the long run.

Move auto-layer-releases flow from lambda to GHA.

TimPansino · 2025-01-06T22:29:03Z

.github/workflows/deploy-python.yml

@@ -182,3 +182,16 @@ jobs:
        env:
          TWINE_USERNAME: __token__
          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+
+      - name: Create release tags for Lambda and K8s Init Containers
+        uses: dev-hanz-ops/install-gh-cli-action@c78dbed4be2f8d6133a14a9a597ee12fd4ed5c93 # v3


gh should be preinstalled on all runners, I think this 3rd party action is unnecessary.

https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/using-github-cli-in-workflows

TimPansino · 2025-01-08T00:15:42Z

.github/workflows/deploy-python.yml

+      - name: Create release tags for Lambda and K8s Init Containers
+        run: |
+          gh auth login --with-token <<< $GH_RELEASE_TOKEN
+          echo "newrelic/newrelic-lambda-layers - Releasing New Relic Python Agent ${GITHUB_REF}.0 with tag ${GITHUB_REF}.0_python"
+          gh create release "${GITHUB_REF}.0_python" -t "New Relic Python Agent ${GITHUB_REF}.0" --repo=newrelic/newrelic-lambda-layers
+          echo "newrelic/newrelic-agent-init-container - Releasing New Relic Python Agent ${GITHUB_REF}.0 with tag ${GITHUB_REF}.0_python"
+          gh create release "${GITHUB_REF}.0_python" -t "New Relic Python Agent ${GITHUB_REF}.0" --repo=newrelic/newrelic-agent-init-container


Suggested change

- name: Create release tags for Lambda and K8s Init Containers

run: |

gh auth login --with-token <<< $GH_RELEASE_TOKEN

echo "newrelic/newrelic-lambda-layers - Releasing New Relic Python Agent ${GITHUB_REF}.0 with tag ${GITHUB_REF}.0_python"

gh create release "${GITHUB_REF}.0_python" -t "New Relic Python Agent ${GITHUB_REF}.0" --repo=newrelic/newrelic-lambda-layers

echo "newrelic/newrelic-agent-init-container - Releasing New Relic Python Agent ${GITHUB_REF}.0 with tag ${GITHUB_REF}.0_python"

gh create release "${GITHUB_REF}.0_python" -t "New Relic Python Agent ${GITHUB_REF}.0" --repo=newrelic/newrelic-agent-init-container

- name: Create release tags for Lambda and K8s Init Containers

run: |

RELEASE_TITLE="New Relic Python Agent ${GITHUB_REF}.0"

RELEASE_TAG="${GITHUB_REF}.0_python"

RELEASE_NOTES="Automated release for [Python Agent ${GITHUB_REF}](https://github.com/newrelic/newrelic-python-agent/releases/tag/${GITHUB_REF})"

gh auth login --with-token <<< $GH_RELEASE_TOKEN

echo "newrelic/newrelic-lambda-layers - Releasing ${RELEASE_TITLE} with tag ${RELEASE_TAG}"

gh release create "${RELEASE_TAG}" --title=${RELEASE_TITLE} --repo=newrelic/newrelic-lambda-layers --notes=${RELEASE_NOTES}

echo "newrelic/newrelic-agent-init-container - Releasing ${RELEASE_TITLE} with tag ${RELEASE_TAG}"

gh release create "${RELEASE_TAG}" --title=${RELEASE_TITLE} --repo=newrelic/newrelic-agent-init-container --notes=${RELEASE_NOTES}

I have 3 suggestions here, going to lump them together but if you don't like one of them I can separate it.

You have the subcommands backwards: gh create release -> gh release create

To make this slightly more DRY so it's easier to update for other agents, can we maybe pull these repeated expressions out into constants that are created once and then referenced?

This would be a good opportunity to fix a random issue that annoys me, the release notes that are autogenerated by Github when none are supplied just ends up being the last commit message, which looks really strange and confusing when they have nothing to do with the agent being released. Can we provide a simple release note that just redirects to the original agent release on Github? That way it will always point to both the ref on Github and the actual release notes from that release are either there or linked on our docs site.

hmstepanek requested a review from a team as a code owner December 16, 2024 20:15

hmstepanek commented Dec 16, 2024

View reviewed changes

.github/workflows/deploy-python.yml Outdated Show resolved Hide resolved

mergify bot added the tests-failing label Dec 16, 2024

TimPansino reviewed Dec 16, 2024

View reviewed changes

.github/scripts/releases.py Outdated

@@ -0,0 +1,70 @@

#!/bin/bash

Copy link

Contributor

TimPansino Dec 16, 2024

Choose a reason for hiding this comment

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

Suggested change

#!/bin/bash

#!/usr/bin/env python3

TimPansino reviewed Dec 16, 2024

View reviewed changes

hmstepanek force-pushed the add-layers-release-flow-to-gha branch from ad59deb to 30b2816 Compare December 17, 2024 23:12

hmstepanek requested a review from TimPansino December 17, 2024 23:14

hmstepanek added 6 commits January 6, 2025 13:53

Add auto-layer-releases flow to deploy flow

830f54c

Move auto-layer-releases flow from lambda to GHA.

Add license info to top of file

3e8794e

Apply suggestions from code review

4142cf3

Convert to gh cli

f16b700

Fixup: lint errors

6833add

Update to latest cli version

9ac223d

hmstepanek force-pushed the add-layers-release-flow-to-gha branch from 690b061 to 9ac223d Compare January 6, 2025 21:53

TimPansino reviewed Jan 6, 2025

View reviewed changes

Use pre-installed gh

0988d57

hmstepanek requested a review from TimPansino January 7, 2025 01:19

TimPansino reviewed Jan 8, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add auto-layer-releases flow to deploy flow #1274

Add auto-layer-releases flow to deploy flow #1274

hmstepanek commented Dec 16, 2024

github-actions bot commented Dec 16, 2024 •

edited

Loading

codecov-commenter commented Dec 16, 2024 •

edited

Loading

TimPansino Dec 16, 2024

TimPansino Dec 16, 2024

hmstepanek Dec 17, 2024

TimPansino Dec 16, 2024

hmstepanek Dec 17, 2024

TimPansino commented Dec 16, 2024

hmstepanek commented Dec 17, 2024

TimPansino Jan 6, 2025

TimPansino Jan 8, 2025

		tag_name = f"{latest_version}.0_{runtime}"
		release_name = f"New Relic {runtime} Agent {latest_version}.0"

Add auto-layer-releases flow to deploy flow #1274

Are you sure you want to change the base?

Add auto-layer-releases flow to deploy flow #1274

Conversation

hmstepanek commented Dec 16, 2024

Overview

github-actions bot commented Dec 16, 2024 • edited Loading

🦙 MegaLinter status: ✅ SUCCESS

codecov-commenter commented Dec 16, 2024 • edited Loading

Codecov Report

TimPansino Dec 16, 2024

Choose a reason for hiding this comment

TimPansino Dec 16, 2024

Choose a reason for hiding this comment

hmstepanek Dec 17, 2024

Choose a reason for hiding this comment

TimPansino Dec 16, 2024

Choose a reason for hiding this comment

hmstepanek Dec 17, 2024

Choose a reason for hiding this comment

TimPansino commented Dec 16, 2024

hmstepanek commented Dec 17, 2024

TimPansino Jan 6, 2025

Choose a reason for hiding this comment

TimPansino Jan 8, 2025

Choose a reason for hiding this comment

github-actions bot commented Dec 16, 2024 •

edited

Loading

codecov-commenter commented Dec 16, 2024 •

edited

Loading