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

Add @spruce release to user-agent #155

Merged
merged 5 commits into from
Nov 7, 2023

Conversation

austin-denoble
Copy link
Contributor

@austin-denoble austin-denoble commented Nov 6, 2023

This revision is dependent on a previous branches / PRs. These will need to be reviewed and merged first:

Problem

We want to be able to track usage specific to the spruce release of the client.

Solution

  • Update buildUserAgent logic to check for packageInfo.release, and append to the user agent if present.
  • Update release-spruce-dev and release-spruce workflows to add @spruce to version.json during these specific releases.

Type of Change

  • New feature (non-breaking change which adds functionality)

Test Plan

We will need to release through either the release-spruce or release-spruce-dev workflows and validate the version.json file has the proper info, and the release is appended to the user agent header.

@austin-denoble austin-denoble changed the base branch from main to adenoble/update-validator-for-literals November 6, 2023 18:52
Copy link
Collaborator

@jhamon jhamon left a comment

Choose a reason for hiding this comment

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

Instead of reading from packageInfo, I would prefer to read an env var that we can set in CI during the build/release process. That way we don't end up with residual code stuff that is spruce-specific when we merge to main later. You can ship this as is if you want, but if you do, you should make a ticket to clean it up later.

@austin-denoble austin-denoble force-pushed the adenoble/update-validator-for-literals branch from 2ad2a18 to c655eae Compare November 7, 2023 18:52
Base automatically changed from adenoble/update-validator-for-literals to spruce November 7, 2023 19:22
@austin-denoble austin-denoble force-pushed the adenoble/add-spruce-user-agent branch from 20435ae to 28b38d6 Compare November 7, 2023 19:27
@austin-denoble
Copy link
Contributor Author

Instead of reading from packageInfo, I would prefer to read an env var that we can set in CI during the build/release process. That way we don't end up with residual code stuff that is spruce-specific when we merge to main later. You can ship this as is if you want, but if you do, you should make a ticket to clean it up later.

That does make more sense. I'll get that changed in this PR.

@austin-denoble austin-denoble merged commit b7b3755 into spruce Nov 7, 2023
16 of 19 checks passed
@austin-denoble austin-denoble deleted the adenoble/add-spruce-user-agent branch November 7, 2023 22:08
austin-denoble added a commit that referenced this pull request Dec 27, 2023
_This revision is dependent on a previous branches / PRs. These will
need to be reviewed and merged first:_
- #153
- #154

## Problem
We want to be able to track usage specific to the spruce release of the
client.

## Solution
- Update `buildUserAgent` logic to check for `packageInfo.release`, and
append to the user agent if present.
- Update `release-spruce-dev` and `release-spruce` workflows to add
`@spruce` to `version.json` during these specific releases.

## Type of Change
- [X] New feature (non-breaking change which adds functionality)

## Test Plan
We will need to release through either the `release-spruce` or
`release-spruce-dev` workflows and validate the `version.json` file has
the proper info, and the `release` is appended to the user agent header.
austin-denoble added a commit that referenced this pull request Jan 13, 2024
_This revision is dependent on a previous branches / PRs. These will
need to be reviewed and merged first:_
- #153
- #154

We want to be able to track usage specific to the spruce release of the
client.

- Update `buildUserAgent` logic to check for `packageInfo.release`, and
append to the user agent if present.
- Update `release-spruce-dev` and `release-spruce` workflows to add
`@spruce` to `version.json` during these specific releases.

- [X] New feature (non-breaking change which adds functionality)

We will need to release through either the `release-spruce` or
`release-spruce-dev` workflows and validate the `version.json` file has
the proper info, and the `release` is appended to the user agent header.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants